From 0af939c17bb07715414456f9a3e8baf506b09e57 Mon Sep 17 00:00:00 2001 From: epolon Date: Thu, 24 Sep 2020 20:07:01 +0300 Subject: [PATCH 01/36] rename addChart => addHelmChart --- packages/@aws-cdk/aws-eks/README.md | 16 ++++++++-------- packages/@aws-cdk/aws-eks/lib/cluster.ts | 6 +++--- packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts | 4 ++-- .../@aws-cdk/aws-eks/test/integ.eks-cluster.ts | 4 ++-- packages/@aws-cdk/aws-eks/test/test.cluster.ts | 2 +- .../@aws-cdk/aws-eks/test/test.k8s-manifest.ts | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index bf9200ce865ad..94c0b186355ff 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -206,11 +206,11 @@ this.cluster.addNodegroup('extra-ng', { ### ARM64 Support -Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest +Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest Amazon Linux 2 AMI for ARM64 will be automatically selected. ```ts -// create a cluster with a default managed nodegroup +// create a cluster with a default managed nodegroup cluster = new eks.Cluster(this, 'Cluster', { vpc, mastersRole, @@ -669,10 +669,10 @@ unfortunately beyond the scope of this documentation. ### Helm Charts -The `HelmChart` construct or `cluster.addChart` method can be used +The `HelmChart` construct or `cluster.addHelmChart` method can be used to add Kubernetes resources to this cluster using Helm. -> When using `cluster.addChart`, the manifest construct is defined within the cluster's stack scope. If the manifest contains +> When using `cluster.addHelmChart`, the manifest construct is defined within the cluster's stack scope. If the manifest contains > attributes from a different stack which depend on the cluster stack, a circular dependency will be created and you will get a synth time error. > To avoid this, directly use `new HelmChart` to create the chart in the scope of the other stack. @@ -688,8 +688,8 @@ new HelmChart(this, 'NginxIngress', { namespace: 'kube-system' }); -// or, option2: use `addChart` -cluster.addChart('NginxIngress', { +// or, option2: use `addHelmChart` +cluster.addHelmChart('NginxIngress', { chart: 'nginx-ingress', repository: 'https://helm.nginx.com/stable', namespace: 'kube-system' @@ -716,8 +716,8 @@ resource or if Helm charts depend on each other. You can use charts: ```ts -const chart1 = cluster.addChart(...); -const chart2 = cluster.addChart(...); +const chart1 = cluster.addHelmChart(...); +const chart2 = cluster.addHelmChart(...); chart2.node.addDependency(chart1); ``` diff --git a/packages/@aws-cdk/aws-eks/lib/cluster.ts b/packages/@aws-cdk/aws-eks/lib/cluster.ts index c753b7b81f784..6da5e6fa414d7 100644 --- a/packages/@aws-cdk/aws-eks/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/cluster.ts @@ -126,7 +126,7 @@ export interface ICluster extends IResource, ec2.IConnectable { * @param options options of this chart. * @returns a `HelmChart` construct */ - addChart(id: string, options: HelmChartOptions): HelmChart; + addHelmChart(id: string, options: HelmChartOptions): HelmChart; } /** @@ -609,7 +609,7 @@ abstract class ClusterBase extends Resource implements ICluster { * @param options options of this chart. * @returns a `HelmChart` construct */ - public addChart(id: string, options: HelmChartOptions): HelmChart { + public addHelmChart(id: string, options: HelmChartOptions): HelmChart { return new HelmChart(this, `chart-${id}`, { cluster: this, ...options }); } } @@ -1333,7 +1333,7 @@ export class Cluster extends ClusterBase { */ private addSpotInterruptHandler() { if (!this._spotInterruptHandler) { - this._spotInterruptHandler = this.addChart('spot-interrupt-handler', { + this._spotInterruptHandler = this.addHelmChart('spot-interrupt-handler', { chart: 'aws-node-termination-handler', version: '0.9.5', repository: 'https://aws.github.io/eks-charts', diff --git a/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts b/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts index 348adff45f6df..5d7f46d6d94b0 100644 --- a/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts @@ -366,7 +366,7 @@ export class LegacyCluster extends Resource implements ICluster { throw new Error('legacy cluster does not support adding kubernetes manifests'); } - public addChart(_id: string, _options: HelmChartOptions): HelmChart { + public addHelmChart(_id: string, _options: HelmChartOptions): HelmChart { throw new Error('legacy cluster does not support adding helm charts'); } @@ -424,7 +424,7 @@ class ImportedCluster extends Resource implements ICluster { throw new Error('legacy cluster does not support adding kubernetes manifests'); } - public addChart(_id: string, _options: HelmChartOptions): HelmChart { + public addHelmChart(_id: string, _options: HelmChartOptions): HelmChart { throw new Error('legacy cluster does not support adding helm charts'); } diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts index 7f399939344f9..936b26fa906b9 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts @@ -87,7 +87,7 @@ class EksClusterStack extends TestStack { }, }); - const nginxIngress = this.cluster.addChart('nginx-ingress', { + const nginxIngress = this.cluster.addHelmChart('nginx-ingress', { chart: 'nginx-ingress', repository: 'https://helm.nginx.com/stable', namespace: 'nginx', @@ -103,7 +103,7 @@ class EksClusterStack extends TestStack { } private assertSimpleHelmChart() { // deploy the Kubernetes dashboard through a helm chart - this.cluster.addChart('dashboard', { + this.cluster.addHelmChart('dashboard', { chart: 'kubernetes-dashboard', repository: 'https://kubernetes.github.io/dashboard/', }); diff --git a/packages/@aws-cdk/aws-eks/test/test.cluster.ts b/packages/@aws-cdk/aws-eks/test/test.cluster.ts index cd32b5ce42566..1e5845dbc753d 100644 --- a/packages/@aws-cdk/aws-eks/test/test.cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/test.cluster.ts @@ -1532,7 +1532,7 @@ export = { }); // WHEN - cluster.addChart('MyChart', { + cluster.addHelmChart('MyChart', { chart: 'foo', }); diff --git a/packages/@aws-cdk/aws-eks/test/test.k8s-manifest.ts b/packages/@aws-cdk/aws-eks/test/test.k8s-manifest.ts index 900fc852d4b94..b00a33012c5ae 100644 --- a/packages/@aws-cdk/aws-eks/test/test.k8s-manifest.ts +++ b/packages/@aws-cdk/aws-eks/test/test.k8s-manifest.ts @@ -88,7 +88,7 @@ export = { // WHEN cluster.addManifest('foo', { bar: 2334 }); - cluster.addChart('helm', { chart: 'hello-world' }); + cluster.addHelmChart('helm', { chart: 'hello-world' }); // THEN expect(stack).to(haveResource(KubernetesManifest.RESOURCE_TYPE, { From ffaa5b17155e52a09097cf27787f982e44f4a015 Mon Sep 17 00:00:00 2001 From: epolon Date: Thu, 24 Sep 2020 20:18:13 +0300 Subject: [PATCH 02/36] rename capacity methods --- packages/@aws-cdk/aws-eks/README.md | 14 +++--- packages/@aws-cdk/aws-eks/lib/cluster.ts | 18 ++++---- .../test/example.ssh-into-nodes.lit.ts | 2 +- .../aws-eks/test/integ.eks-cluster.ts | 16 +++---- .../@aws-cdk/aws-eks/test/test.awsauth.ts | 2 +- .../@aws-cdk/aws-eks/test/test.cluster.ts | 44 +++++++++---------- .../@aws-cdk/aws-eks/test/test.nodegroup.ts | 12 ++--- 7 files changed, 54 insertions(+), 54 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 94c0b186355ff..b314e39ab1c96 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -147,11 +147,11 @@ And the `cluster.defaultNodegroup` property will reference the `Nodegroup` resource for the default capacity. It will be `undefined` if `defaultCapacity` is set to `0` or `defaultCapacityType` is `EC2`. -You can add `AutoScalingGroup` resource as customized capacity through `cluster.addCapacity()` or +You can add `AutoScalingGroup` resource as customized capacity through `cluster.addAutoScalingGroupCapacity()` or `cluster.addAutoScalingGroup()`: ```ts -cluster.addCapacity('frontend-nodes', { +cluster.addAutoScalingGroupCapacity('frontend-nodes', { instanceType: new ec2.InstanceType('t2.medium'), minCapacity: 3, vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } @@ -224,7 +224,7 @@ cluster.addNodegroup('extra-ng-arm', { }); // add a self-managed ARM64 nodegroup -cluster.addCapacity('self-ng-arm', { +cluster.addAutoScalingGroupCapacity('self-ng-arm', { instanceType: new ec2.InstanceType('m6g.medium'), minCapacity: 2, }) @@ -280,7 +280,7 @@ on Amazon EKS (minimum version v1.1.4). If `spotPrice` is specified, the capacity will be purchased from spot instances: ```ts -cluster.addCapacity('spot', { +cluster.addAutoScalingGroupCapacity('spot', { spotPrice: '0.1094', instanceType: new ec2.InstanceType('t3.large'), maxCapacity: 10 @@ -314,7 +314,7 @@ you can use `kubeletExtraArgs` to add custom node labels or taints. ```ts // up to ten spot instances -cluster.addCapacity('spot', { +cluster.addAutoScalingGroupCapacity('spot', { instanceType: new ec2.InstanceType('t3.large'), minCapacity: 2, bootstrapOptions: { @@ -596,7 +596,7 @@ on your behalf and exposes an API through the `cluster.awsAuth` for mapping users, roles and accounts. Furthermore, when auto-scaling capacity is added to the cluster (through -`cluster.addCapacity` or `cluster.addAutoScalingGroup`), the IAM instance role +`cluster.addAutoScalingGroupCapacity` or `cluster.addAutoScalingGroup`), the IAM instance role of the auto-scaling group will be automatically mapped to RBAC so nodes can connect to the cluster. No manual mapping is required any longer. @@ -732,7 +732,7 @@ The following example will create a capacity with self-managed Amazon EC2 capaci ```ts // add bottlerocket nodes -cluster.addCapacity('BottlerocketNodes', { +cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { instanceType: new ec2.InstanceType('t3.small'), minCapacity: 2, machineImageType: eks.MachineImageType.BOTTLEROCKET diff --git a/packages/@aws-cdk/aws-eks/lib/cluster.ts b/packages/@aws-cdk/aws-eks/lib/cluster.ts index 6da5e6fa414d7..9693bac1c6c33 100644 --- a/packages/@aws-cdk/aws-eks/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/cluster.ts @@ -507,7 +507,7 @@ export interface ClusterProps extends ClusterOptions { * Instance type can be configured through `defaultCapacityInstanceType`, * which defaults to `m5.large`. * - * Use `cluster.addCapacity` to add additional customized capacity. Set this + * Use `cluster.addAutoScalingGroupCapacity` to add additional customized capacity. Set this * to `0` is you wish to avoid the initial capacity allocation. * * @default 2 @@ -984,10 +984,10 @@ export class Cluster extends ClusterBase { if (minCapacity > 0) { const instanceType = props.defaultCapacityInstance || DEFAULT_CAPACITY_TYPE; this.defaultCapacity = props.defaultCapacityType === DefaultCapacityType.EC2 ? - this.addCapacity('DefaultCapacity', { instanceType, minCapacity }) : undefined; + this.addAutoScalingGroupCapacity('DefaultCapacity', { instanceType, minCapacity }) : undefined; this.defaultNodegroup = props.defaultCapacityType !== DefaultCapacityType.EC2 ? - this.addNodegroup('DefaultCapacity', { instanceType, minSize: minCapacity }) : undefined; + this.addNodegroupCapacity('DefaultCapacity', { instanceType, minSize: minCapacity }) : undefined; } const outputConfigCommand = props.outputConfigCommand === undefined ? true : props.outputConfigCommand; @@ -1036,7 +1036,7 @@ export class Cluster extends ClusterBase { * daemon will be installed on all spot instances to handle * [EC2 Spot Instance Termination Notices](https://aws.amazon.com/blogs/aws/new-ec2-spot-instance-termination-notices/). */ - public addCapacity(id: string, options: CapacityOptions): autoscaling.AutoScalingGroup { + public addAutoScalingGroupCapacity(id: string, options: CapacityOptions): autoscaling.AutoScalingGroup { if (options.machineImageType === MachineImageType.BOTTLEROCKET && options.bootstrapOptions !== undefined ) { throw new Error('bootstrapOptions is not supported for Bottlerocket'); } @@ -1056,7 +1056,7 @@ export class Cluster extends ClusterBase { instanceType: options.instanceType, }); - this.addAutoScalingGroup(asg, { + this.connectAutoScalingGroupCapacity(asg, { mapRole: options.mapRole, bootstrapOptions: options.bootstrapOptions, bootstrapEnabled: options.bootstrapEnabled, @@ -1079,7 +1079,7 @@ export class Cluster extends ClusterBase { * @param id The ID of the nodegroup * @param options options for creating a new nodegroup */ - public addNodegroup(id: string, options?: NodegroupOptions): Nodegroup { + public addNodegroupCapacity(id: string, options?: NodegroupOptions): Nodegroup { return new Nodegroup(this, `Nodegroup${id}`, { cluster: this, ...options, @@ -1087,7 +1087,7 @@ export class Cluster extends ClusterBase { } /** - * Add compute capacity to this EKS cluster in the form of an AutoScalingGroup + * Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. * * The AutoScalingGroup must be running an EKS-optimized AMI containing the * /etc/eks/bootstrap.sh script. This method will configure Security Groups, @@ -1100,13 +1100,13 @@ export class Cluster extends ClusterBase { * daemon will be installed on all spot instances to handle * [EC2 Spot Instance Termination Notices](https://aws.amazon.com/blogs/aws/new-ec2-spot-instance-termination-notices/). * - * Prefer to use `addCapacity` if possible. + * Prefer to use `addAutoScalingGroupCapacity` if possible. * * @see https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html * @param autoScalingGroup [disable-awslint:ref-via-interface] * @param options options for adding auto scaling groups, like customizing the bootstrap script */ - public addAutoScalingGroup(autoScalingGroup: autoscaling.AutoScalingGroup, options: AutoScalingGroupOptions) { + public connectAutoScalingGroupCapacity(autoScalingGroup: autoscaling.AutoScalingGroup, options: AutoScalingGroupOptions) { // self rules autoScalingGroup.connections.allowInternally(ec2.Port.allTraffic()); diff --git a/packages/@aws-cdk/aws-eks/test/example.ssh-into-nodes.lit.ts b/packages/@aws-cdk/aws-eks/test/example.ssh-into-nodes.lit.ts index 3e33c697c1c45..9b4e03ad40ebe 100644 --- a/packages/@aws-cdk/aws-eks/test/example.ssh-into-nodes.lit.ts +++ b/packages/@aws-cdk/aws-eks/test/example.ssh-into-nodes.lit.ts @@ -14,7 +14,7 @@ class EksClusterStack extends cdk.Stack { }); /// !show - const asg = cluster.addCapacity('Nodes', { + const asg = cluster.addAutoScalingGroupCapacity('Nodes', { instanceType: new ec2.InstanceType('t2.medium'), vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC }, keyName: 'my-key-name', diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts index 936b26fa906b9..89ceb71559686 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts @@ -114,7 +114,7 @@ class EksClusterStack extends TestStack { } private assertNodeGroupX86() { // add a extra nodegroup - this.cluster.addNodegroup('extra-ng', { + this.cluster.addNodegroupCapacity('extra-ng', { instanceType: new ec2.InstanceType('t3.small'), minSize: 1, // reusing the default capacity nodegroup instance role when available @@ -135,7 +135,7 @@ class EksClusterStack extends TestStack { userData: Fn.base64(userData.render()), }, }); - this.cluster.addNodegroup('extra-ng2', { + this.cluster.addNodegroupCapacity('extra-ng2', { minSize: 1, // reusing the default capacity nodegroup instance role when available nodeRole: this.cluster.defaultNodegroup?.role || this.cluster.defaultCapacity?.role, @@ -147,7 +147,7 @@ class EksClusterStack extends TestStack { } private assertNodeGroupArm() { // add a extra nodegroup - this.cluster.addNodegroup('extra-ng-arm', { + this.cluster.addNodegroupCapacity('extra-ng-arm', { instanceType: new ec2.InstanceType('m6g.medium'), minSize: 1, // reusing the default capacity nodegroup instance role when available @@ -156,14 +156,14 @@ class EksClusterStack extends TestStack { } private assertInferenceInstances() { // inference instances - this.cluster.addCapacity('InferenceInstances', { + this.cluster.addAutoScalingGroupCapacity('InferenceInstances', { instanceType: new ec2.InstanceType('inf1.2xlarge'), minCapacity: 1, }); } private assertSpotCapacity() { // spot instances (up to 10) - this.cluster.addCapacity('spot', { + this.cluster.addAutoScalingGroupCapacity('spot', { spotPrice: '0.1094', instanceType: new ec2.InstanceType('t3.large'), maxCapacity: 10, @@ -175,7 +175,7 @@ class EksClusterStack extends TestStack { } private assertBottlerocket() { // add bottlerocket nodes - this.cluster.addCapacity('BottlerocketNodes', { + this.cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { instanceType: new ec2.InstanceType('t3.small'), minCapacity: 2, machineImageType: eks.MachineImageType.BOTTLEROCKET, @@ -185,7 +185,7 @@ class EksClusterStack extends TestStack { private assertCapacityX86() { // add some x86_64 capacity to the cluster. The IAM instance role will // automatically be mapped via aws-auth to allow nodes to join the cluster. - this.cluster.addCapacity('Nodes', { + this.cluster.addAutoScalingGroupCapacity('Nodes', { instanceType: new ec2.InstanceType('t2.medium'), minCapacity: 3, }); @@ -194,7 +194,7 @@ class EksClusterStack extends TestStack { private assertCapacityArm() { // add some arm64 capacity to the cluster. The IAM instance role will // automatically be mapped via aws-auth to allow nodes to join the cluster. - this.cluster.addCapacity('NodesArm', { + this.cluster.addAutoScalingGroupCapacity('NodesArm', { instanceType: new ec2.InstanceType('m6g.medium'), minCapacity: 1, }); diff --git a/packages/@aws-cdk/aws-eks/test/test.awsauth.ts b/packages/@aws-cdk/aws-eks/test/test.awsauth.ts index 0ae28ba00b2c7..519f2c1415b06 100644 --- a/packages/@aws-cdk/aws-eks/test/test.awsauth.ts +++ b/packages/@aws-cdk/aws-eks/test/test.awsauth.ts @@ -234,7 +234,7 @@ export = { // GIVEN const { stack } = testFixtureNoVpc(); const cluster = new Cluster(stack, 'Cluster', { version: CLUSTER_VERSION }); - cluster.addNodegroup('NG'); + cluster.addNodegroupCapacity('NG'); const role = iam.Role.fromRoleArn(stack, 'imported-role', 'arn:aws:iam::123456789012:role/S3Access'); // WHEN diff --git a/packages/@aws-cdk/aws-eks/test/test.cluster.ts b/packages/@aws-cdk/aws-eks/test/test.cluster.ts index 1e5845dbc753d..c8b646b059012 100644 --- a/packages/@aws-cdk/aws-eks/test/test.cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/test.cluster.ts @@ -239,7 +239,7 @@ export = { const capacityStack = new CapacityStack(app, 'CapacityStack', { cluster: clusterStack.eksCluster }); try { - clusterStack.eksCluster.addAutoScalingGroup(capacityStack.group, {}); + clusterStack.eksCluster.connectAutoScalingGroupCapacity(capacityStack.group, {}); test.ok(false, 'expected error'); } catch (err) { test.equal(err.message, 'CapacityStackautoScalingInstanceRoleF041EB53 should be defined in the scope of the ClusterStack stack to prevent circular dependencies'); @@ -472,7 +472,7 @@ export = { }); // WHEN - cluster.addCapacity('Default', { + cluster.addAutoScalingGroupCapacity('Default', { instanceType: new ec2.InstanceType('t2.medium'), }); @@ -490,7 +490,7 @@ export = { }); // WHEN - cluster.addCapacity('Default', { + cluster.addAutoScalingGroupCapacity('Default', { instanceType: new ec2.InstanceType('t2.medium'), }); @@ -555,7 +555,7 @@ export = { }); // WHEN - cluster.addCapacity('Bottlerocket', { + cluster.addAutoScalingGroupCapacity('Bottlerocket', { instanceType: new ec2.InstanceType('t2.medium'), machineImageType: eks.MachineImageType.BOTTLEROCKET, }); @@ -587,7 +587,7 @@ export = { version: CLUSTER_VERSION, }); - test.throws(() => cluster.addCapacity('Bottlerocket', { + test.throws(() => cluster.addAutoScalingGroupCapacity('Bottlerocket', { instanceType: new ec2.InstanceType('t2.medium'), machineImageType: eks.MachineImageType.BOTTLEROCKET, bootstrapOptions: {}, @@ -785,7 +785,7 @@ export = { }); // WHEN - cluster.addCapacity('default', { + cluster.addAutoScalingGroupCapacity('default', { instanceType: new ec2.InstanceType('t2.nano'), }); @@ -825,7 +825,7 @@ export = { test.done(); }, - 'addCapacity will *not* map the IAM role if mapRole is false'(test: Test) { + 'addAutoScalingGroupCapacity will *not* map the IAM role if mapRole is false'(test: Test) { // GIVEN const { stack, vpc } = testFixture(); const cluster = new eks.Cluster(stack, 'Cluster', { @@ -835,7 +835,7 @@ export = { }); // WHEN - cluster.addCapacity('default', { + cluster.addAutoScalingGroupCapacity('default', { instanceType: new ec2.InstanceType('t2.nano'), mapRole: false, }); @@ -975,7 +975,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlargs') }); + cluster.addAutoScalingGroupCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlargs') }); // THEN const template = app.synth().getStackByName(stack.stackName).template; @@ -990,7 +990,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('MyCapcity', { + cluster.addAutoScalingGroupCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlargs'), bootstrapEnabled: false, }); @@ -1009,7 +1009,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('MyCapcity', { + cluster.addAutoScalingGroupCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlargs'), bootstrapOptions: { kubeletExtraArgs: '--node-labels FOO=42', @@ -1031,7 +1031,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('MyCapcity', { + cluster.addAutoScalingGroupCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlargs'), spotPrice: '0.01', }); @@ -1049,7 +1049,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('MyCapcity', { + cluster.addAutoScalingGroupCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlarge'), spotPrice: '0.01', }); @@ -1071,12 +1071,12 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('Spot1', { + cluster.addAutoScalingGroupCapacity('Spot1', { instanceType: new ec2.InstanceType('m3.xlarge'), spotPrice: '0.01', }); - cluster.addCapacity('Spot2', { + cluster.addAutoScalingGroupCapacity('Spot2', { instanceType: new ec2.InstanceType('m4.xlarge'), spotPrice: '0.01', }); @@ -1096,7 +1096,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // THEN - test.throws(() => cluster.addCapacity('MyCapcity', { + test.throws(() => cluster.addAutoScalingGroupCapacity('MyCapcity', { instanceType: new ec2.InstanceType('m3.xlargs'), bootstrapEnabled: false, bootstrapOptions: { awsApiRetryAttempts: 10 }, @@ -1174,7 +1174,7 @@ export = { defaultCapacity: 0, version: CLUSTER_VERSION, defaultCapacityInstance: new ec2.InstanceType('m6g.medium'), - }).addNodegroup('ng', { + }).addNodegroupCapacity('ng', { instanceType: new ec2.InstanceType('m6g.medium'), }); @@ -1185,7 +1185,7 @@ export = { test.done(); }, - 'EKS-Optimized AMI with GPU support when addCapacity'(test: Test) { + 'EKS-Optimized AMI with GPU support when addAutoScalingGroupCapacity'(test: Test) { // GIVEN const { app, stack } = testFixtureNoVpc(); @@ -1193,7 +1193,7 @@ export = { new eks.Cluster(stack, 'cluster', { defaultCapacity: 0, version: CLUSTER_VERSION, - }).addCapacity('GPUCapacity', { + }).addAutoScalingGroupCapacity('GPUCapacity', { instanceType: new ec2.InstanceType('g4dn.xlarge'), }); @@ -1206,7 +1206,7 @@ export = { test.done(); }, - 'EKS-Optimized AMI with ARM64 when addCapacity'(test: Test) { + 'EKS-Optimized AMI with ARM64 when addAutoScalingGroupCapacity'(test: Test) { // GIVEN const { app, stack } = testFixtureNoVpc(); @@ -1214,7 +1214,7 @@ export = { new eks.Cluster(stack, 'cluster', { defaultCapacity: 0, version: CLUSTER_VERSION, - }).addCapacity('ARMCapacity', { + }).addAutoScalingGroupCapacity('ARMCapacity', { instanceType: new ec2.InstanceType('m6g.medium'), }); @@ -1636,7 +1636,7 @@ export = { const cluster = new eks.Cluster(stack, 'Cluster', { defaultCapacity: 0, version: CLUSTER_VERSION }); // WHEN - cluster.addCapacity('InferenceInstances', { + cluster.addAutoScalingGroupCapacity('InferenceInstances', { instanceType: new ec2.InstanceType('inf1.2xlarge'), minCapacity: 1, }); diff --git a/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts b/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts index 35f1d7e6ce3fd..83a60d517d944 100644 --- a/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts +++ b/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts @@ -271,7 +271,7 @@ export = { }); // WHEN - cluster.addNodegroup('ng'); + cluster.addNodegroupCapacity('ng'); // THEN expect(stack).to(haveResourceLike('AWS::EKS::Nodegroup', { @@ -312,7 +312,7 @@ export = { version: CLUSTER_VERSION, }); // THEN - test.throws(() => cluster.addNodegroup('ng', { desiredSize: 3, maxSize: 2 }), /Desired capacity 3 can't be greater than max size 2/); + test.throws(() => cluster.addNodegroupCapacity('ng', { desiredSize: 3, maxSize: 2 }), /Desired capacity 3 can't be greater than max size 2/); test.done(); }, 'throws when desiredSize < minSize'(test: Test) { @@ -325,7 +325,7 @@ export = { version: CLUSTER_VERSION, }); // THEN - test.throws(() => cluster.addNodegroup('ng', { desiredSize: 2, minSize: 3 }), /Minimum capacity 3 can't be greater than desired size 2/); + test.throws(() => cluster.addNodegroupCapacity('ng', { desiredSize: 2, minSize: 3 }), /Minimum capacity 3 can't be greater than desired size 2/); test.done(); }, 'create nodegroup correctly with launch template'(test: Test) { @@ -351,7 +351,7 @@ export = { userData: cdk.Fn.base64(userData.render()), }, }); - cluster.addNodegroup('ng-lt', { + cluster.addNodegroupCapacity('ng-lt', { launchTemplate: { id: lt.ref, version: lt.attrDefaultVersionNumber, @@ -400,7 +400,7 @@ export = { }); // THEN test.throws(() => - cluster.addNodegroup('ng-lt', { + cluster.addNodegroupCapacity('ng-lt', { diskSize: 100, launchTemplate: { id: lt.ref, @@ -434,7 +434,7 @@ export = { }); // THEN test.throws(() => - cluster.addNodegroup('ng-lt', { + cluster.addNodegroupCapacity('ng-lt', { instanceType: new ec2.InstanceType('c5.large'), launchTemplate: { id: lt.ref, From 107214bb5d22a0e5969d0165145e41c167003a9b Mon Sep 17 00:00:00 2001 From: epolon Date: Thu, 24 Sep 2020 20:23:03 +0300 Subject: [PATCH 03/36] rename launchTemplate to launchTemplateSpec --- packages/@aws-cdk/aws-eks/README.md | 2 +- packages/@aws-cdk/aws-eks/lib/managed-nodegroup.ts | 12 ++++++------ packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts | 2 +- packages/@aws-cdk/aws-eks/test/test.nodegroup.ts | 6 +++--- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index b314e39ab1c96..51e5ed593db14 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -197,7 +197,7 @@ const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { }, }); this.cluster.addNodegroup('extra-ng', { - launchTemplate: { + launchTemplateSpec: { id: lt.ref, version: lt.attrDefaultVersionNumber, }, diff --git a/packages/@aws-cdk/aws-eks/lib/managed-nodegroup.ts b/packages/@aws-cdk/aws-eks/lib/managed-nodegroup.ts index f65f4f844c2c8..9d94eef7d55fe 100644 --- a/packages/@aws-cdk/aws-eks/lib/managed-nodegroup.ts +++ b/packages/@aws-cdk/aws-eks/lib/managed-nodegroup.ts @@ -59,7 +59,7 @@ export interface NodegroupRemoteAccess { /** * Launch template property specification */ -export interface LaunchTemplate { +export interface LaunchTemplateSpec { /** * The Launch template ID */ @@ -177,11 +177,11 @@ export interface NodegroupOptions { */ readonly tags?: { [name: string]: string }; /** - * Launch template used for the nodegroup + * Launch template specification used for the nodegroup * @see - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html * @default - no launch template */ - readonly launchTemplate?: LaunchTemplate; + readonly launchTemplateSpec?: LaunchTemplateSpec; } /** @@ -290,7 +290,7 @@ export class Nodegroup extends Resource implements INodegroup { tags: props.tags, }); - if (props.launchTemplate) { + if (props.launchTemplateSpec) { if (props.diskSize) { // see - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html // and https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-disksize @@ -303,8 +303,8 @@ export class Nodegroup extends Resource implements INodegroup { } // TODO: update this when the L1 resource spec is updated. resource.addPropertyOverride('LaunchTemplate', { - Id: props.launchTemplate.id, - Version: props.launchTemplate.version, + Id: props.launchTemplateSpec.id, + Version: props.launchTemplateSpec.version, }); } diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts index 89ceb71559686..689d6cee92068 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts @@ -139,7 +139,7 @@ class EksClusterStack extends TestStack { minSize: 1, // reusing the default capacity nodegroup instance role when available nodeRole: this.cluster.defaultNodegroup?.role || this.cluster.defaultCapacity?.role, - launchTemplate: { + launchTemplateSpec: { id: lt.ref, version: lt.attrDefaultVersionNumber, }, diff --git a/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts b/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts index 83a60d517d944..8f9409331d8a6 100644 --- a/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts +++ b/packages/@aws-cdk/aws-eks/test/test.nodegroup.ts @@ -352,7 +352,7 @@ export = { }, }); cluster.addNodegroupCapacity('ng-lt', { - launchTemplate: { + launchTemplateSpec: { id: lt.ref, version: lt.attrDefaultVersionNumber, }, @@ -402,7 +402,7 @@ export = { test.throws(() => cluster.addNodegroupCapacity('ng-lt', { diskSize: 100, - launchTemplate: { + launchTemplateSpec: { id: lt.ref, version: lt.attrDefaultVersionNumber, }, @@ -436,7 +436,7 @@ export = { test.throws(() => cluster.addNodegroupCapacity('ng-lt', { instanceType: new ec2.InstanceType('c5.large'), - launchTemplate: { + launchTemplateSpec: { id: lt.ref, version: lt.attrDefaultVersionNumber, }, From f24e819cae1d9d574806636ab96c7679543849b3 Mon Sep 17 00:00:00 2001 From: epolon Date: Thu, 24 Sep 2020 22:50:25 +0300 Subject: [PATCH 04/36] flip maturity to dev preview --- packages/@aws-cdk/aws-eks/README.md | 6 +++--- packages/@aws-cdk/aws-eks/package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 0913a8ea6de5b..aebdd8c4c75a9 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -1,5 +1,4 @@ ## Amazon EKS Construct Library - --- @@ -7,13 +6,14 @@ > All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use. -![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge) +![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.svg?style=for-the-badge) -> The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package. +> The APIs of higher level constructs in this module are in **developer preview** before they become stable. We will only make breaking changes to address unforeseen API issues. Therefore, these APIs are not subject to [Semantic Versioning](https://semver.org/), and breaking changes will be announced in release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package. --- + This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters programmatically. This library also supports programmatically defining Kubernetes resource diff --git a/packages/@aws-cdk/aws-eks/package.json b/packages/@aws-cdk/aws-eks/package.json index 8dfe97519e1d3..603f304655a6b 100644 --- a/packages/@aws-cdk/aws-eks/package.json +++ b/packages/@aws-cdk/aws-eks/package.json @@ -110,7 +110,7 @@ ] }, "stability": "experimental", - "maturity": "experimental", + "maturity": "developer-preview", "awscdkio": { "announce": false } From 8db26464e2292aa6ccb0afe60a00e212baef8361 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 12:24:01 +0300 Subject: [PATCH 05/36] fix test --- packages/@aws-cdk/aws-eks/lib/cluster.ts | 7 + .../@aws-cdk/aws-eks/lib/legacy-cluster.ts | 9 + packages/@aws-cdk/aws-eks/package.json | 2 + .../aws-eks/test/imports/k8s-v1_17_0.ts | 13982 ++++++++++++++++ .../test/integ.eks-cluster.expected.json | 137 +- .../aws-eks/test/integ.eks-cluster.ts | 17 + .../@aws-cdk/aws-eks/test/test.cluster.ts | 44 + yarn.lock | 691 +- 8 files changed, 14825 insertions(+), 64 deletions(-) create mode 100644 packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts diff --git a/packages/@aws-cdk/aws-eks/lib/cluster.ts b/packages/@aws-cdk/aws-eks/lib/cluster.ts index c753b7b81f784..f874343c1ebab 100644 --- a/packages/@aws-cdk/aws-eks/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/cluster.ts @@ -7,6 +7,7 @@ import * as kms from '@aws-cdk/aws-kms'; import * as lambda from '@aws-cdk/aws-lambda'; import * as ssm from '@aws-cdk/aws-ssm'; import { Annotations, CfnOutput, CfnResource, Construct, IResource, Resource, Stack, Tags, Token, Duration } from '@aws-cdk/core'; +import * as cdk8s from 'cdk8s'; import * as YAML from 'yaml'; import { AwsAuth } from './aws-auth'; import { ClusterResource, clusterArnComponents } from './cluster-resource'; @@ -127,6 +128,8 @@ export interface ICluster extends IResource, ec2.IConnectable { * @returns a `HelmChart` construct */ addChart(id: string, options: HelmChartOptions): HelmChart; + + addCdk8sChart(id: string, chart: cdk8s.Chart): KubernetesManifest; } /** @@ -612,6 +615,10 @@ abstract class ClusterBase extends Resource implements ICluster { public addChart(id: string, options: HelmChartOptions): HelmChart { return new HelmChart(this, `chart-${id}`, { cluster: this, ...options }); } + + public addCdk8sChart(id: string, chart: cdk8s.Chart): KubernetesManifest { + return this.addManifest(id, ...chart.toJson()); + } } /** diff --git a/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts b/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts index 348adff45f6df..d6ea1c55cfc52 100644 --- a/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts @@ -4,6 +4,7 @@ import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import * as ssm from '@aws-cdk/aws-ssm'; import { Annotations, CfnOutput, Construct, Resource, Stack, Token, Tags } from '@aws-cdk/core'; +import * as cdk8s from 'cdk8s'; import { ICluster, ClusterAttributes, KubernetesVersion, NodeType, DefaultCapacityType, EksOptimizedImage, CapacityOptions, MachineImageType, AutoScalingGroupOptions, CommonClusterOptions } from './cluster'; import { clusterArnComponents } from './cluster-resource'; import { CfnCluster, CfnClusterProps } from './eks.generated'; @@ -370,6 +371,10 @@ export class LegacyCluster extends Resource implements ICluster { throw new Error('legacy cluster does not support adding helm charts'); } + public addCdk8sChart(_id: string, _chart: cdk8s.Chart): KubernetesManifest { + throw new Error('legacy cluster does not support adding cdk8s charts'); + } + /** * Opportunistically tag subnets with the required tags. * @@ -428,6 +433,10 @@ class ImportedCluster extends Resource implements ICluster { throw new Error('legacy cluster does not support adding helm charts'); } + public addCdk8sChart(_id: string, _chart: cdk8s.Chart): KubernetesManifest { + throw new Error('legacy cluster does not support adding cdk8s charts'); + } + public get vpc() { if (!this.props.vpc) { throw new Error('"vpc" is not defined for this imported cluster'); diff --git a/packages/@aws-cdk/aws-eks/package.json b/packages/@aws-cdk/aws-eks/package.json index 8dfe97519e1d3..281a33fe8a04d 100644 --- a/packages/@aws-cdk/aws-eks/package.json +++ b/packages/@aws-cdk/aws-eks/package.json @@ -83,6 +83,7 @@ "@aws-cdk/aws-ssm": "0.0.0", "@aws-cdk/core": "0.0.0", "@aws-cdk/custom-resources": "0.0.0", + "cdk8s": "0.28.0", "constructs": "^3.0.4", "yaml": "1.10.0" }, @@ -99,6 +100,7 @@ "@aws-cdk/aws-ssm": "0.0.0", "@aws-cdk/core": "0.0.0", "@aws-cdk/custom-resources": "0.0.0", + "cdk8s": "0.28.0", "constructs": "^3.0.4" }, "engines": { diff --git a/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts b/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts new file mode 100644 index 0000000000000..9dc6024a5ef71 --- /dev/null +++ b/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts @@ -0,0 +1,13982 @@ +// generated by cdk8s +import { ApiObject } from 'cdk8s'; +import { Construct } from 'constructs'; + +/** + * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration + */ +export class MutatingWebhookConfiguration extends ApiObject { + /** + * Defines a "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: MutatingWebhookConfigurationOptions = {}) { + super(scope, name, { + ...options, + kind: 'MutatingWebhookConfiguration', + apiVersion: 'admissionregistration.k8s.io/v1', + }); + } +} + +/** + * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList + */ +export class MutatingWebhookConfigurationList extends ApiObject { + /** + * Defines a "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: MutatingWebhookConfigurationListOptions) { + super(scope, name, { + ...options, + kind: 'MutatingWebhookConfigurationList', + apiVersion: 'admissionregistration.k8s.io/v1', + }); + } +} + +/** + * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration + */ +export class ValidatingWebhookConfiguration extends ApiObject { + /** + * Defines a "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ValidatingWebhookConfigurationOptions = {}) { + super(scope, name, { + ...options, + kind: 'ValidatingWebhookConfiguration', + apiVersion: 'admissionregistration.k8s.io/v1', + }); + } +} + +/** + * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList + */ +export class ValidatingWebhookConfigurationList extends ApiObject { + /** + * Defines a "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ValidatingWebhookConfigurationListOptions) { + super(scope, name, { + ...options, + kind: 'ValidatingWebhookConfigurationList', + apiVersion: 'admissionregistration.k8s.io/v1', + }); + } +} + +/** + * ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. + * + * @schema io.k8s.api.apps.v1.ControllerRevision + */ +export class ControllerRevision extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.ControllerRevision" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ControllerRevisionOptions) { + super(scope, name, { + ...options, + kind: 'ControllerRevision', + apiVersion: 'apps/v1', + }); + } +} + +/** + * ControllerRevisionList is a resource containing a list of ControllerRevision objects. + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList + */ +export class ControllerRevisionList extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.ControllerRevisionList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ControllerRevisionListOptions) { + super(scope, name, { + ...options, + kind: 'ControllerRevisionList', + apiVersion: 'apps/v1', + }); + } +} + +/** + * DaemonSet represents the configuration of a daemon set. + * + * @schema io.k8s.api.apps.v1.DaemonSet + */ +export class DaemonSet extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.DaemonSet" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: DaemonSetOptions = {}) { + super(scope, name, { + ...options, + kind: 'DaemonSet', + apiVersion: 'apps/v1', + }); + } +} + +/** + * DaemonSetList is a collection of daemon sets. + * + * @schema io.k8s.api.apps.v1.DaemonSetList + */ +export class DaemonSetList extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.DaemonSetList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: DaemonSetListOptions) { + super(scope, name, { + ...options, + kind: 'DaemonSetList', + apiVersion: 'apps/v1', + }); + } +} + +/** + * Deployment enables declarative updates for Pods and ReplicaSets. + * + * @schema io.k8s.api.apps.v1.Deployment + */ +export class Deployment extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.Deployment" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: DeploymentOptions = {}) { + super(scope, name, { + ...options, + kind: 'Deployment', + apiVersion: 'apps/v1', + }); + } +} + +/** + * DeploymentList is a list of Deployments. + * + * @schema io.k8s.api.apps.v1.DeploymentList + */ +export class DeploymentList extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.DeploymentList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: DeploymentListOptions) { + super(scope, name, { + ...options, + kind: 'DeploymentList', + apiVersion: 'apps/v1', + }); + } +} + +/** + * ReplicaSet ensures that a specified number of pod replicas are running at any given time. + * + * @schema io.k8s.api.apps.v1.ReplicaSet + */ +export class ReplicaSet extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.ReplicaSet" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ReplicaSetOptions = {}) { + super(scope, name, { + ...options, + kind: 'ReplicaSet', + apiVersion: 'apps/v1', + }); + } +} + +/** + * ReplicaSetList is a collection of ReplicaSets. + * + * @schema io.k8s.api.apps.v1.ReplicaSetList + */ +export class ReplicaSetList extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.ReplicaSetList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ReplicaSetListOptions) { + super(scope, name, { + ...options, + kind: 'ReplicaSetList', + apiVersion: 'apps/v1', + }); + } +} + +/** + * StatefulSet represents a set of pods with consistent identities. Identities are defined as: + - Network: A single stable DNS and hostname. + - Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity. + * + * @schema io.k8s.api.apps.v1.StatefulSet + */ +export class StatefulSet extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.StatefulSet" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: StatefulSetOptions = {}) { + super(scope, name, { + ...options, + kind: 'StatefulSet', + apiVersion: 'apps/v1', + }); + } +} + +/** + * StatefulSetList is a collection of StatefulSets. + * + * @schema io.k8s.api.apps.v1.StatefulSetList + */ +export class StatefulSetList extends ApiObject { + /** + * Defines a "io.k8s.api.apps.v1.StatefulSetList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: StatefulSetListOptions) { + super(scope, name, { + ...options, + kind: 'StatefulSetList', + apiVersion: 'apps/v1', + }); + } +} + +/** + * Scale represents a scaling request for a resource. + * + * @schema io.k8s.api.autoscaling.v1.Scale + */ +export class Scale extends ApiObject { + /** + * Defines a "io.k8s.api.autoscaling.v1.Scale" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ScaleOptions = {}) { + super(scope, name, { + ...options, + kind: 'Scale', + apiVersion: 'autoscaling/v1', + }); + } +} + +/** + * AuditSink represents a cluster level audit sink + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink + */ +export class AuditSink extends ApiObject { + /** + * Defines a "io.k8s.api.auditregistration.v1alpha1.AuditSink" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: AuditSinkOptions = {}) { + super(scope, name, { + ...options, + kind: 'AuditSink', + apiVersion: 'auditregistration.k8s.io/v1alpha1', + }); + } +} + +/** + * AuditSinkList is a list of AuditSink items. + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList + */ +export class AuditSinkList extends ApiObject { + /** + * Defines a "io.k8s.api.auditregistration.v1alpha1.AuditSinkList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: AuditSinkListOptions) { + super(scope, name, { + ...options, + kind: 'AuditSinkList', + apiVersion: 'auditregistration.k8s.io/v1alpha1', + }); + } +} + +/** + * TokenRequest requests a token for a given service account. + * + * @schema io.k8s.api.authentication.v1.TokenRequest + */ +export class TokenRequest extends ApiObject { + /** + * Defines a "io.k8s.api.authentication.v1.TokenRequest" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: TokenRequestOptions) { + super(scope, name, { + ...options, + kind: 'TokenRequest', + apiVersion: 'authentication.k8s.io/v1', + }); + } +} + +/** + * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + * + * @schema io.k8s.api.authentication.v1.TokenReview + */ +export class TokenReview extends ApiObject { + /** + * Defines a "io.k8s.api.authentication.v1.TokenReview" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: TokenReviewOptions) { + super(scope, name, { + ...options, + kind: 'TokenReview', + apiVersion: 'authentication.k8s.io/v1', + }); + } +} + +/** + * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + * + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview + */ +export class LocalSubjectAccessReview extends ApiObject { + /** + * Defines a "io.k8s.api.authorization.v1.LocalSubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: LocalSubjectAccessReviewOptions) { + super(scope, name, { + ...options, + kind: 'LocalSubjectAccessReview', + apiVersion: 'authorization.k8s.io/v1', + }); + } +} + +/** + * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview + */ +export class SelfSubjectAccessReview extends ApiObject { + /** + * Defines a "io.k8s.api.authorization.v1.SelfSubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: SelfSubjectAccessReviewOptions) { + super(scope, name, { + ...options, + kind: 'SelfSubjectAccessReview', + apiVersion: 'authorization.k8s.io/v1', + }); + } +} + +/** + * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview + */ +export class SelfSubjectRulesReview extends ApiObject { + /** + * Defines a "io.k8s.api.authorization.v1.SelfSubjectRulesReview" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: SelfSubjectRulesReviewOptions) { + super(scope, name, { + ...options, + kind: 'SelfSubjectRulesReview', + apiVersion: 'authorization.k8s.io/v1', + }); + } +} + +/** + * SubjectAccessReview checks whether or not a user or group can perform an action. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReview + */ +export class SubjectAccessReview extends ApiObject { + /** + * Defines a "io.k8s.api.authorization.v1.SubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: SubjectAccessReviewOptions) { + super(scope, name, { + ...options, + kind: 'SubjectAccessReview', + apiVersion: 'authorization.k8s.io/v1', + }); + } +} + +/** + * configuration of a horizontal pod autoscaler. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler + */ +export class HorizontalPodAutoscaler extends ApiObject { + /** + * Defines a "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: HorizontalPodAutoscalerOptions = {}) { + super(scope, name, { + ...options, + kind: 'HorizontalPodAutoscaler', + apiVersion: 'autoscaling/v1', + }); + } +} + +/** + * list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList + */ +export class HorizontalPodAutoscalerList extends ApiObject { + /** + * Defines a "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: HorizontalPodAutoscalerListOptions) { + super(scope, name, { + ...options, + kind: 'HorizontalPodAutoscalerList', + apiVersion: 'autoscaling/v1', + }); + } +} + +/** + * Job represents the configuration of a single job. + * + * @schema io.k8s.api.batch.v1.Job + */ +export class Job extends ApiObject { + /** + * Defines a "io.k8s.api.batch.v1.Job" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: JobOptions = {}) { + super(scope, name, { + ...options, + kind: 'Job', + apiVersion: 'batch/v1', + }); + } +} + +/** + * JobList is a collection of jobs. + * + * @schema io.k8s.api.batch.v1.JobList + */ +export class JobList extends ApiObject { + /** + * Defines a "io.k8s.api.batch.v1.JobList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: JobListOptions) { + super(scope, name, { + ...options, + kind: 'JobList', + apiVersion: 'batch/v1', + }); + } +} + +/** + * CronJob represents the configuration of a single cron job. + * + * @schema io.k8s.api.batch.v1beta1.CronJob + */ +export class CronJob extends ApiObject { + /** + * Defines a "io.k8s.api.batch.v1beta1.CronJob" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CronJobOptions = {}) { + super(scope, name, { + ...options, + kind: 'CronJob', + apiVersion: 'batch/v1beta1', + }); + } +} + +/** + * CronJobList is a collection of cron jobs. + * + * @schema io.k8s.api.batch.v1beta1.CronJobList + */ +export class CronJobList extends ApiObject { + /** + * Defines a "io.k8s.api.batch.v1beta1.CronJobList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CronJobListOptions) { + super(scope, name, { + ...options, + kind: 'CronJobList', + apiVersion: 'batch/v1beta1', + }); + } +} + +/** + * Describes a certificate signing request + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest + */ +export class CertificateSigningRequest extends ApiObject { + /** + * Defines a "io.k8s.api.certificates.v1beta1.CertificateSigningRequest" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CertificateSigningRequestOptions = {}) { + super(scope, name, { + ...options, + kind: 'CertificateSigningRequest', + apiVersion: 'certificates.k8s.io/v1beta1', + }); + } +} + +/** + * + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList + */ +export class CertificateSigningRequestList extends ApiObject { + /** + * Defines a "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CertificateSigningRequestListOptions) { + super(scope, name, { + ...options, + kind: 'CertificateSigningRequestList', + apiVersion: 'certificates.k8s.io/v1beta1', + }); + } +} + +/** + * Lease defines a lease concept. + * + * @schema io.k8s.api.coordination.v1.Lease + */ +export class Lease extends ApiObject { + /** + * Defines a "io.k8s.api.coordination.v1.Lease" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: LeaseOptions = {}) { + super(scope, name, { + ...options, + kind: 'Lease', + apiVersion: 'coordination.k8s.io/v1', + }); + } +} + +/** + * LeaseList is a list of Lease objects. + * + * @schema io.k8s.api.coordination.v1.LeaseList + */ +export class LeaseList extends ApiObject { + /** + * Defines a "io.k8s.api.coordination.v1.LeaseList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: LeaseListOptions) { + super(scope, name, { + ...options, + kind: 'LeaseList', + apiVersion: 'coordination.k8s.io/v1', + }); + } +} + +/** + * Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. + * + * @schema io.k8s.api.core.v1.Binding + */ +export class Binding extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Binding" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: BindingOptions) { + super(scope, name, { + ...options, + kind: 'Binding', + apiVersion: 'v1', + }); + } +} + +/** + * ComponentStatus (and ComponentStatusList) holds the cluster validation info. + * + * @schema io.k8s.api.core.v1.ComponentStatus + */ +export class ComponentStatus extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ComponentStatus" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ComponentStatusOptions = {}) { + super(scope, name, { + ...options, + kind: 'ComponentStatus', + apiVersion: 'v1', + }); + } +} + +/** + * Status of all the conditions for the component as a list of ComponentStatus objects. + * + * @schema io.k8s.api.core.v1.ComponentStatusList + */ +export class ComponentStatusList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ComponentStatusList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ComponentStatusListOptions) { + super(scope, name, { + ...options, + kind: 'ComponentStatusList', + apiVersion: 'v1', + }); + } +} + +/** + * ConfigMap holds configuration data for pods to consume. + * + * @schema io.k8s.api.core.v1.ConfigMap + */ +export class ConfigMap extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ConfigMap" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ConfigMapOptions = {}) { + super(scope, name, { + ...options, + kind: 'ConfigMap', + apiVersion: 'v1', + }); + } +} + +/** + * ConfigMapList is a resource containing a list of ConfigMap objects. + * + * @schema io.k8s.api.core.v1.ConfigMapList + */ +export class ConfigMapList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ConfigMapList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ConfigMapListOptions) { + super(scope, name, { + ...options, + kind: 'ConfigMapList', + apiVersion: 'v1', + }); + } +} + +/** + * Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ] + * + * @schema io.k8s.api.core.v1.Endpoints + */ +export class Endpoints extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Endpoints" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EndpointsOptions = {}) { + super(scope, name, { + ...options, + kind: 'Endpoints', + apiVersion: 'v1', + }); + } +} + +/** + * EndpointsList is a list of endpoints. + * + * @schema io.k8s.api.core.v1.EndpointsList + */ +export class EndpointsList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.EndpointsList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EndpointsListOptions) { + super(scope, name, { + ...options, + kind: 'EndpointsList', + apiVersion: 'v1', + }); + } +} + +/** + * Event is a report of an event somewhere in the cluster. + * + * @schema io.k8s.api.core.v1.Event + */ +export class Event extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Event" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EventOptions) { + super(scope, name, { + ...options, + kind: 'Event', + apiVersion: 'v1', + }); + } +} + +/** + * EventList is a list of events. + * + * @schema io.k8s.api.core.v1.EventList + */ +export class EventList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.EventList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EventListOptions) { + super(scope, name, { + ...options, + kind: 'EventList', + apiVersion: 'v1', + }); + } +} + +/** + * LimitRange sets resource usage limits for each kind of resource in a Namespace. + * + * @schema io.k8s.api.core.v1.LimitRange + */ +export class LimitRange extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.LimitRange" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: LimitRangeOptions = {}) { + super(scope, name, { + ...options, + kind: 'LimitRange', + apiVersion: 'v1', + }); + } +} + +/** + * LimitRangeList is a list of LimitRange items. + * + * @schema io.k8s.api.core.v1.LimitRangeList + */ +export class LimitRangeList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.LimitRangeList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: LimitRangeListOptions) { + super(scope, name, { + ...options, + kind: 'LimitRangeList', + apiVersion: 'v1', + }); + } +} + +/** + * Namespace provides a scope for Names. Use of multiple namespaces is optional. + * + * @schema io.k8s.api.core.v1.Namespace + */ +export class Namespace extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Namespace" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: NamespaceOptions = {}) { + super(scope, name, { + ...options, + kind: 'Namespace', + apiVersion: 'v1', + }); + } +} + +/** + * NamespaceList is a list of Namespaces. + * + * @schema io.k8s.api.core.v1.NamespaceList + */ +export class NamespaceList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.NamespaceList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: NamespaceListOptions) { + super(scope, name, { + ...options, + kind: 'NamespaceList', + apiVersion: 'v1', + }); + } +} + +/** + * Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). + * + * @schema io.k8s.api.core.v1.Node + */ +export class Node extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Node" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: NodeOptions = {}) { + super(scope, name, { + ...options, + kind: 'Node', + apiVersion: 'v1', + }); + } +} + +/** + * NodeList is the whole list of all Nodes which have been registered with master. + * + * @schema io.k8s.api.core.v1.NodeList + */ +export class NodeList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.NodeList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: NodeListOptions) { + super(scope, name, { + ...options, + kind: 'NodeList', + apiVersion: 'v1', + }); + } +} + +/** + * PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolume + */ +export class PersistentVolume extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PersistentVolume" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PersistentVolumeOptions = {}) { + super(scope, name, { + ...options, + kind: 'PersistentVolume', + apiVersion: 'v1', + }); + } +} + +/** + * PersistentVolumeClaim is a user's request for and claim to a persistent volume + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim + */ +export class PersistentVolumeClaim extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PersistentVolumeClaim" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PersistentVolumeClaimOptions = {}) { + super(scope, name, { + ...options, + kind: 'PersistentVolumeClaim', + apiVersion: 'v1', + }); + } +} + +/** + * PersistentVolumeClaimList is a list of PersistentVolumeClaim items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList + */ +export class PersistentVolumeClaimList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PersistentVolumeClaimList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PersistentVolumeClaimListOptions) { + super(scope, name, { + ...options, + kind: 'PersistentVolumeClaimList', + apiVersion: 'v1', + }); + } +} + +/** + * PersistentVolumeList is a list of PersistentVolume items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeList + */ +export class PersistentVolumeList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PersistentVolumeList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PersistentVolumeListOptions) { + super(scope, name, { + ...options, + kind: 'PersistentVolumeList', + apiVersion: 'v1', + }); + } +} + +/** + * Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. + * + * @schema io.k8s.api.core.v1.Pod + */ +export class Pod extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Pod" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodOptions = {}) { + super(scope, name, { + ...options, + kind: 'Pod', + apiVersion: 'v1', + }); + } +} + +/** + * PodList is a list of Pods. + * + * @schema io.k8s.api.core.v1.PodList + */ +export class PodList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PodList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodListOptions) { + super(scope, name, { + ...options, + kind: 'PodList', + apiVersion: 'v1', + }); + } +} + +/** + * PodTemplate describes a template for creating copies of a predefined pod. + * + * @schema io.k8s.api.core.v1.PodTemplate + */ +export class PodTemplate extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PodTemplate" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodTemplateOptions = {}) { + super(scope, name, { + ...options, + kind: 'PodTemplate', + apiVersion: 'v1', + }); + } +} + +/** + * PodTemplateList is a list of PodTemplates. + * + * @schema io.k8s.api.core.v1.PodTemplateList + */ +export class PodTemplateList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.PodTemplateList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodTemplateListOptions) { + super(scope, name, { + ...options, + kind: 'PodTemplateList', + apiVersion: 'v1', + }); + } +} + +/** + * ReplicationController represents the configuration of a replication controller. + * + * @schema io.k8s.api.core.v1.ReplicationController + */ +export class ReplicationController extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ReplicationController" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ReplicationControllerOptions = {}) { + super(scope, name, { + ...options, + kind: 'ReplicationController', + apiVersion: 'v1', + }); + } +} + +/** + * ReplicationControllerList is a collection of replication controllers. + * + * @schema io.k8s.api.core.v1.ReplicationControllerList + */ +export class ReplicationControllerList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ReplicationControllerList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ReplicationControllerListOptions) { + super(scope, name, { + ...options, + kind: 'ReplicationControllerList', + apiVersion: 'v1', + }); + } +} + +/** + * ResourceQuota sets aggregate quota restrictions enforced per namespace + * + * @schema io.k8s.api.core.v1.ResourceQuota + */ +export class ResourceQuota extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ResourceQuota" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ResourceQuotaOptions = {}) { + super(scope, name, { + ...options, + kind: 'ResourceQuota', + apiVersion: 'v1', + }); + } +} + +/** + * ResourceQuotaList is a list of ResourceQuota items. + * + * @schema io.k8s.api.core.v1.ResourceQuotaList + */ +export class ResourceQuotaList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ResourceQuotaList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ResourceQuotaListOptions) { + super(scope, name, { + ...options, + kind: 'ResourceQuotaList', + apiVersion: 'v1', + }); + } +} + +/** + * Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + * + * @schema io.k8s.api.core.v1.Secret + */ +export class Secret extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Secret" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: SecretOptions = {}) { + super(scope, name, { + ...options, + kind: 'Secret', + apiVersion: 'v1', + }); + } +} + +/** + * SecretList is a list of Secret. + * + * @schema io.k8s.api.core.v1.SecretList + */ +export class SecretList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.SecretList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: SecretListOptions) { + super(scope, name, { + ...options, + kind: 'SecretList', + apiVersion: 'v1', + }); + } +} + +/** + * Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. + * + * @schema io.k8s.api.core.v1.Service + */ +export class Service extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.Service" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ServiceOptions = {}) { + super(scope, name, { + ...options, + kind: 'Service', + apiVersion: 'v1', + }); + } +} + +/** + * ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets + * + * @schema io.k8s.api.core.v1.ServiceAccount + */ +export class ServiceAccount extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ServiceAccount" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ServiceAccountOptions = {}) { + super(scope, name, { + ...options, + kind: 'ServiceAccount', + apiVersion: 'v1', + }); + } +} + +/** + * ServiceAccountList is a list of ServiceAccount objects + * + * @schema io.k8s.api.core.v1.ServiceAccountList + */ +export class ServiceAccountList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ServiceAccountList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ServiceAccountListOptions) { + super(scope, name, { + ...options, + kind: 'ServiceAccountList', + apiVersion: 'v1', + }); + } +} + +/** + * ServiceList holds a list of services. + * + * @schema io.k8s.api.core.v1.ServiceList + */ +export class ServiceList extends ApiObject { + /** + * Defines a "io.k8s.api.core.v1.ServiceList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ServiceListOptions) { + super(scope, name, { + ...options, + kind: 'ServiceList', + apiVersion: 'v1', + }); + } +} + +/** + * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice + */ +export class EndpointSlice extends ApiObject { + /** + * Defines a "io.k8s.api.discovery.v1beta1.EndpointSlice" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EndpointSliceOptions) { + super(scope, name, { + ...options, + kind: 'EndpointSlice', + apiVersion: 'discovery.k8s.io/v1beta1', + }); + } +} + +/** + * EndpointSliceList represents a list of endpoint slices + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList + */ +export class EndpointSliceList extends ApiObject { + /** + * Defines a "io.k8s.api.discovery.v1beta1.EndpointSliceList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EndpointSliceListOptions) { + super(scope, name, { + ...options, + kind: 'EndpointSliceList', + apiVersion: 'discovery.k8s.io/v1beta1', + }); + } +} + +/** + * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + * + * @schema io.k8s.api.networking.v1beta1.Ingress + */ +export class Ingress extends ApiObject { + /** + * Defines a "io.k8s.api.networking.v1beta1.Ingress" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: IngressOptions = {}) { + super(scope, name, { + ...options, + kind: 'Ingress', + apiVersion: 'networking.k8s.io/v1beta1', + }); + } +} + +/** + * IngressList is a collection of Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressList + */ +export class IngressList extends ApiObject { + /** + * Defines a "io.k8s.api.networking.v1beta1.IngressList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: IngressListOptions) { + super(scope, name, { + ...options, + kind: 'IngressList', + apiVersion: 'networking.k8s.io/v1beta1', + }); + } +} + +/** + * NetworkPolicy describes what network traffic is allowed for a set of Pods + * + * @schema io.k8s.api.networking.v1.NetworkPolicy + */ +export class NetworkPolicy extends ApiObject { + /** + * Defines a "io.k8s.api.networking.v1.NetworkPolicy" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: NetworkPolicyOptions = {}) { + super(scope, name, { + ...options, + kind: 'NetworkPolicy', + apiVersion: 'networking.k8s.io/v1', + }); + } +} + +/** + * NetworkPolicyList is a list of NetworkPolicy objects. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList + */ +export class NetworkPolicyList extends ApiObject { + /** + * Defines a "io.k8s.api.networking.v1.NetworkPolicyList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: NetworkPolicyListOptions) { + super(scope, name, { + ...options, + kind: 'NetworkPolicyList', + apiVersion: 'networking.k8s.io/v1', + }); + } +} + +/** + * PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy + */ +export class PodSecurityPolicy extends ApiObject { + /** + * Defines a "io.k8s.api.policy.v1beta1.PodSecurityPolicy" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodSecurityPolicyOptions = {}) { + super(scope, name, { + ...options, + kind: 'PodSecurityPolicy', + apiVersion: 'policy/v1beta1', + }); + } +} + +/** + * PodSecurityPolicyList is a list of PodSecurityPolicy objects. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList + */ +export class PodSecurityPolicyList extends ApiObject { + /** + * Defines a "io.k8s.api.policy.v1beta1.PodSecurityPolicyList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodSecurityPolicyListOptions) { + super(scope, name, { + ...options, + kind: 'PodSecurityPolicyList', + apiVersion: 'policy/v1beta1', + }); + } +} + +/** + * FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema + */ +export class FlowSchema extends ApiObject { + /** + * Defines a "io.k8s.api.flowcontrol.v1alpha1.FlowSchema" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: FlowSchemaOptions = {}) { + super(scope, name, { + ...options, + kind: 'FlowSchema', + apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', + }); + } +} + +/** + * FlowSchemaList is a list of FlowSchema objects. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList + */ +export class FlowSchemaList extends ApiObject { + /** + * Defines a "io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: FlowSchemaListOptions) { + super(scope, name, { + ...options, + kind: 'FlowSchemaList', + apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', + }); + } +} + +/** + * PriorityLevelConfiguration represents the configuration of a priority level. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration + */ +export class PriorityLevelConfiguration extends ApiObject { + /** + * Defines a "io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PriorityLevelConfigurationOptions = {}) { + super(scope, name, { + ...options, + kind: 'PriorityLevelConfiguration', + apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', + }); + } +} + +/** + * PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList + */ +export class PriorityLevelConfigurationList extends ApiObject { + /** + * Defines a "io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PriorityLevelConfigurationListOptions) { + super(scope, name, { + ...options, + kind: 'PriorityLevelConfigurationList', + apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', + }); + } +} + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass + */ +export class RuntimeClass extends ApiObject { + /** + * Defines a "io.k8s.api.node.v1beta1.RuntimeClass" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: RuntimeClassOptions) { + super(scope, name, { + ...options, + kind: 'RuntimeClass', + apiVersion: 'node.k8s.io/v1beta1', + }); + } +} + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList + */ +export class RuntimeClassList extends ApiObject { + /** + * Defines a "io.k8s.api.node.v1beta1.RuntimeClassList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: RuntimeClassListOptions) { + super(scope, name, { + ...options, + kind: 'RuntimeClassList', + apiVersion: 'node.k8s.io/v1beta1', + }); + } +} + +/** + * Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. + * + * @schema io.k8s.api.policy.v1beta1.Eviction + */ +export class Eviction extends ApiObject { + /** + * Defines a "io.k8s.api.policy.v1beta1.Eviction" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: EvictionOptions = {}) { + super(scope, name, { + ...options, + kind: 'Eviction', + apiVersion: 'policy/v1beta1', + }); + } +} + +/** + * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget + */ +export class PodDisruptionBudget extends ApiObject { + /** + * Defines a "io.k8s.api.policy.v1beta1.PodDisruptionBudget" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodDisruptionBudgetOptions = {}) { + super(scope, name, { + ...options, + kind: 'PodDisruptionBudget', + apiVersion: 'policy/v1beta1', + }); + } +} + +/** + * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList + */ +export class PodDisruptionBudgetList extends ApiObject { + /** + * Defines a "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodDisruptionBudgetListOptions) { + super(scope, name, { + ...options, + kind: 'PodDisruptionBudgetList', + apiVersion: 'policy/v1beta1', + }); + } +} + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + * + * @schema io.k8s.api.rbac.v1.ClusterRole + */ +export class ClusterRole extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRole" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ClusterRoleOptions = {}) { + super(scope, name, { + ...options, + kind: 'ClusterRole', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding + */ +export class ClusterRoleBinding extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRoleBinding" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ClusterRoleBindingOptions) { + super(scope, name, { + ...options, + kind: 'ClusterRoleBinding', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList + */ +export class ClusterRoleBindingList extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRoleBindingList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ClusterRoleBindingListOptions) { + super(scope, name, { + ...options, + kind: 'ClusterRoleBindingList', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * ClusterRoleList is a collection of ClusterRoles + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList + */ +export class ClusterRoleList extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRoleList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ClusterRoleListOptions) { + super(scope, name, { + ...options, + kind: 'ClusterRoleList', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + * + * @schema io.k8s.api.rbac.v1.Role + */ +export class Role extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.Role" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: RoleOptions = {}) { + super(scope, name, { + ...options, + kind: 'Role', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. + * + * @schema io.k8s.api.rbac.v1.RoleBinding + */ +export class RoleBinding extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.RoleBinding" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: RoleBindingOptions) { + super(scope, name, { + ...options, + kind: 'RoleBinding', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * RoleBindingList is a collection of RoleBindings + * + * @schema io.k8s.api.rbac.v1.RoleBindingList + */ +export class RoleBindingList extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.RoleBindingList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: RoleBindingListOptions) { + super(scope, name, { + ...options, + kind: 'RoleBindingList', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * RoleList is a collection of Roles + * + * @schema io.k8s.api.rbac.v1.RoleList + */ +export class RoleList extends ApiObject { + /** + * Defines a "io.k8s.api.rbac.v1.RoleList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: RoleListOptions) { + super(scope, name, { + ...options, + kind: 'RoleList', + apiVersion: 'rbac.authorization.k8s.io/v1', + }); + } +} + +/** + * PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass + */ +export class PriorityClass extends ApiObject { + /** + * Defines a "io.k8s.api.scheduling.v1.PriorityClass" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PriorityClassOptions) { + super(scope, name, { + ...options, + kind: 'PriorityClass', + apiVersion: 'scheduling.k8s.io/v1', + }); + } +} + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList + */ +export class PriorityClassList extends ApiObject { + /** + * Defines a "io.k8s.api.scheduling.v1.PriorityClassList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PriorityClassListOptions) { + super(scope, name, { + ...options, + kind: 'PriorityClassList', + apiVersion: 'scheduling.k8s.io/v1', + }); + } +} + +/** + * PodPreset is a policy resource that defines additional runtime requirements for a Pod. + * + * @schema io.k8s.api.settings.v1alpha1.PodPreset + */ +export class PodPreset extends ApiObject { + /** + * Defines a "io.k8s.api.settings.v1alpha1.PodPreset" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodPresetOptions = {}) { + super(scope, name, { + ...options, + kind: 'PodPreset', + apiVersion: 'settings.k8s.io/v1alpha1', + }); + } +} + +/** + * PodPresetList is a list of PodPreset objects. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetList + */ +export class PodPresetList extends ApiObject { + /** + * Defines a "io.k8s.api.settings.v1alpha1.PodPresetList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: PodPresetListOptions) { + super(scope, name, { + ...options, + kind: 'PodPresetList', + apiVersion: 'settings.k8s.io/v1alpha1', + }); + } +} + +/** + * CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + * + * @schema io.k8s.api.storage.v1.CSINode + */ +export class CsiNode extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1.CSINode" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CsiNodeOptions) { + super(scope, name, { + ...options, + kind: 'CSINode', + apiVersion: 'storage.k8s.io/v1', + }); + } +} + +/** + * CSINodeList is a collection of CSINode objects. + * + * @schema io.k8s.api.storage.v1.CSINodeList + */ +export class CsiNodeList extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1.CSINodeList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CsiNodeListOptions) { + super(scope, name, { + ...options, + kind: 'CSINodeList', + apiVersion: 'storage.k8s.io/v1', + }); + } +} + +/** + * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + * + * @schema io.k8s.api.storage.v1.StorageClass + */ +export class StorageClass extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1.StorageClass" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: StorageClassOptions) { + super(scope, name, { + ...options, + kind: 'StorageClass', + apiVersion: 'storage.k8s.io/v1', + }); + } +} + +/** + * StorageClassList is a collection of storage classes. + * + * @schema io.k8s.api.storage.v1.StorageClassList + */ +export class StorageClassList extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1.StorageClassList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: StorageClassListOptions) { + super(scope, name, { + ...options, + kind: 'StorageClassList', + apiVersion: 'storage.k8s.io/v1', + }); + } +} + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1.VolumeAttachment + */ +export class VolumeAttachment extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1.VolumeAttachment" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: VolumeAttachmentOptions) { + super(scope, name, { + ...options, + kind: 'VolumeAttachment', + apiVersion: 'storage.k8s.io/v1', + }); + } +} + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList + */ +export class VolumeAttachmentList extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1.VolumeAttachmentList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: VolumeAttachmentListOptions) { + super(scope, name, { + ...options, + kind: 'VolumeAttachmentList', + apiVersion: 'storage.k8s.io/v1', + }); + } +} + +/** + * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver + */ +export class CsiDriver extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1beta1.CSIDriver" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CsiDriverOptions) { + super(scope, name, { + ...options, + kind: 'CSIDriver', + apiVersion: 'storage.k8s.io/v1beta1', + }); + } +} + +/** + * CSIDriverList is a collection of CSIDriver objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList + */ +export class CsiDriverList extends ApiObject { + /** + * Defines a "io.k8s.api.storage.v1beta1.CSIDriverList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CsiDriverListOptions) { + super(scope, name, { + ...options, + kind: 'CSIDriverList', + apiVersion: 'storage.k8s.io/v1beta1', + }); + } +} + +/** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition + */ +export class CustomResourceDefinition extends ApiObject { + /** + * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CustomResourceDefinitionOptions) { + super(scope, name, { + ...options, + kind: 'CustomResourceDefinition', + apiVersion: 'apiextensions.k8s.io/v1', + }); + } +} + +/** + * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList + */ +export class CustomResourceDefinitionList extends ApiObject { + /** + * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: CustomResourceDefinitionListOptions) { + super(scope, name, { + ...options, + kind: 'CustomResourceDefinitionList', + apiVersion: 'apiextensions.k8s.io/v1', + }); + } +} + +/** + * Status is a return value for calls that don't return other objects. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status + */ +export class Status extends ApiObject { + /** + * Defines a "io.k8s.apimachinery.pkg.apis.meta.v1.Status" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: StatusOptions = {}) { + super(scope, name, { + ...options, + kind: 'Status', + apiVersion: 'v1', + }); + } +} + +/** + * APIService represents a server for a particular GroupVersion. Name must be "version.group". + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService + */ +export class ApiService extends ApiObject { + /** + * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ApiServiceOptions = {}) { + super(scope, name, { + ...options, + kind: 'APIService', + apiVersion: 'apiregistration.k8s.io/v1', + }); + } +} + +/** + * APIServiceList is a list of APIService objects. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList + */ +export class ApiServiceList extends ApiObject { + /** + * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList" API object + * @param scope the scope in which to define this object + * @param name a scope-local name for the object + * @param options configuration options + */ + public constructor(scope: Construct, name: string, options: ApiServiceListOptions) { + super(scope, name, { + ...options, + kind: 'APIServiceList', + apiVersion: 'apiregistration.k8s.io/v1', + }); + } +} + +/** + * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration + */ +export interface MutatingWebhookConfigurationOptions { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Webhooks is a list of webhooks and the affected resources and operations. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration#webhooks + */ + readonly webhooks?: MutatingWebhook[]; + +} + +/** + * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList + */ +export interface MutatingWebhookConfigurationListOptions { + /** + * List of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList#items + */ + readonly items: MutatingWebhookConfiguration[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration + */ +export interface ValidatingWebhookConfigurationOptions { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Webhooks is a list of webhooks and the affected resources and operations. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration#webhooks + */ + readonly webhooks?: ValidatingWebhook[]; + +} + +/** + * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList + */ +export interface ValidatingWebhookConfigurationListOptions { + /** + * List of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList#items + */ + readonly items: ValidatingWebhookConfiguration[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. + * + * @schema io.k8s.api.apps.v1.ControllerRevision + */ +export interface ControllerRevisionOptions { + /** + * Data is the serialized representation of the state. + * + * @schema io.k8s.api.apps.v1.ControllerRevision#data + */ + readonly data?: any; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.ControllerRevision#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Revision indicates the revision of the state represented by Data. + * + * @schema io.k8s.api.apps.v1.ControllerRevision#revision + */ + readonly revision: number; + +} + +/** + * ControllerRevisionList is a resource containing a list of ControllerRevision objects. + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList + */ +export interface ControllerRevisionListOptions { + /** + * Items is the list of ControllerRevisions + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList#items + */ + readonly items: ControllerRevision[]; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * DaemonSet represents the configuration of a daemon set. + * + * @schema io.k8s.api.apps.v1.DaemonSet + */ +export interface DaemonSetOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.DaemonSet#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.apps.v1.DaemonSet#spec + */ + readonly spec?: DaemonSetSpec; + +} + +/** + * DaemonSetList is a collection of daemon sets. + * + * @schema io.k8s.api.apps.v1.DaemonSetList + */ +export interface DaemonSetListOptions { + /** + * A list of daemon sets. + * + * @schema io.k8s.api.apps.v1.DaemonSetList#items + */ + readonly items: DaemonSet[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.DaemonSetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Deployment enables declarative updates for Pods and ReplicaSets. + * + * @schema io.k8s.api.apps.v1.Deployment + */ +export interface DeploymentOptions { + /** + * Standard object metadata. + * + * @schema io.k8s.api.apps.v1.Deployment#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the Deployment. + * + * @schema io.k8s.api.apps.v1.Deployment#spec + */ + readonly spec?: DeploymentSpec; + +} + +/** + * DeploymentList is a list of Deployments. + * + * @schema io.k8s.api.apps.v1.DeploymentList + */ +export interface DeploymentListOptions { + /** + * Items is the list of Deployments. + * + * @schema io.k8s.api.apps.v1.DeploymentList#items + */ + readonly items: Deployment[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.apps.v1.DeploymentList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ReplicaSet ensures that a specified number of pod replicas are running at any given time. + * + * @schema io.k8s.api.apps.v1.ReplicaSet + */ +export interface ReplicaSetOptions { + /** + * If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.ReplicaSet#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.apps.v1.ReplicaSet#spec + */ + readonly spec?: ReplicaSetSpec; + +} + +/** + * ReplicaSetList is a collection of ReplicaSets. + * + * @schema io.k8s.api.apps.v1.ReplicaSetList + */ +export interface ReplicaSetListOptions { + /** + * List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller + * + * @schema io.k8s.api.apps.v1.ReplicaSetList#items + */ + readonly items: ReplicaSet[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.apps.v1.ReplicaSetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * StatefulSet represents a set of pods with consistent identities. Identities are defined as: + - Network: A single stable DNS and hostname. + - Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity. + * + * @schema io.k8s.api.apps.v1.StatefulSet + */ +export interface StatefulSetOptions { + /** + * @schema io.k8s.api.apps.v1.StatefulSet#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the desired identities of pods in this set. + * + * @schema io.k8s.api.apps.v1.StatefulSet#spec + */ + readonly spec?: StatefulSetSpec; + +} + +/** + * StatefulSetList is a collection of StatefulSets. + * + * @schema io.k8s.api.apps.v1.StatefulSetList + */ +export interface StatefulSetListOptions { + /** + * @schema io.k8s.api.apps.v1.StatefulSetList#items + */ + readonly items: StatefulSet[]; + + /** + * @schema io.k8s.api.apps.v1.StatefulSetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Scale represents a scaling request for a resource. + * + * @schema io.k8s.api.autoscaling.v1.Scale + */ +export interface ScaleOptions { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.autoscaling.v1.Scale#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + * + * @schema io.k8s.api.autoscaling.v1.Scale#spec + */ + readonly spec?: ScaleSpec; + +} + +/** + * AuditSink represents a cluster level audit sink + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink + */ +export interface AuditSinkOptions { + /** + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the audit configuration spec + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink#spec + */ + readonly spec?: AuditSinkSpec; + +} + +/** + * AuditSinkList is a list of AuditSink items. + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList + */ +export interface AuditSinkListOptions { + /** + * List of audit configurations. + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList#items + */ + readonly items: AuditSink[]; + + /** + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * TokenRequest requests a token for a given service account. + * + * @schema io.k8s.api.authentication.v1.TokenRequest + */ +export interface TokenRequestOptions { + /** + * @schema io.k8s.api.authentication.v1.TokenRequest#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * @schema io.k8s.api.authentication.v1.TokenRequest#spec + */ + readonly spec: TokenRequestSpec; + +} + +/** + * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + * + * @schema io.k8s.api.authentication.v1.TokenReview + */ +export interface TokenReviewOptions { + /** + * @schema io.k8s.api.authentication.v1.TokenReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated + * + * @schema io.k8s.api.authentication.v1.TokenReview#spec + */ + readonly spec: TokenReviewSpec; + +} + +/** + * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + * + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview + */ +export interface LocalSubjectAccessReviewOptions { + /** + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. + * + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview#spec + */ + readonly spec: SubjectAccessReviewSpec; + +} + +/** + * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview + */ +export interface SelfSubjectAccessReviewOptions { + /** + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. user and groups must be empty + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview#spec + */ + readonly spec: SelfSubjectAccessReviewSpec; + +} + +/** + * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview + */ +export interface SelfSubjectRulesReviewOptions { + /** + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview#spec + */ + readonly spec: SelfSubjectRulesReviewSpec; + +} + +/** + * SubjectAccessReview checks whether or not a user or group can perform an action. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReview + */ +export interface SubjectAccessReviewOptions { + /** + * @schema io.k8s.api.authorization.v1.SubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReview#spec + */ + readonly spec: SubjectAccessReviewSpec; + +} + +/** + * configuration of a horizontal pod autoscaler. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler + */ +export interface HorizontalPodAutoscalerOptions { + /** + * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler#spec + */ + readonly spec?: HorizontalPodAutoscalerSpec; + +} + +/** + * list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList + */ +export interface HorizontalPodAutoscalerListOptions { + /** + * list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList#items + */ + readonly items: HorizontalPodAutoscaler[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Job represents the configuration of a single job. + * + * @schema io.k8s.api.batch.v1.Job + */ +export interface JobOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.Job#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * 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 + * + * @schema io.k8s.api.batch.v1.Job#spec + */ + readonly spec?: JobSpec; + +} + +/** + * JobList is a collection of jobs. + * + * @schema io.k8s.api.batch.v1.JobList + */ +export interface JobListOptions { + /** + * items is the list of Jobs. + * + * @schema io.k8s.api.batch.v1.JobList#items + */ + readonly items: Job[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.JobList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * CronJob represents the configuration of a single cron job. + * + * @schema io.k8s.api.batch.v1beta1.CronJob + */ +export interface CronJobOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1beta1.CronJob#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1beta1.CronJob#spec + */ + readonly spec?: CronJobSpec; + +} + +/** + * CronJobList is a collection of cron jobs. + * + * @schema io.k8s.api.batch.v1beta1.CronJobList + */ +export interface CronJobListOptions { + /** + * items is the list of CronJobs. + * + * @schema io.k8s.api.batch.v1beta1.CronJobList#items + */ + readonly items: CronJob[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1beta1.CronJobList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Describes a certificate signing request + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest + */ +export interface CertificateSigningRequestOptions { + /** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The certificate request itself and any additional information. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest#spec + */ + readonly spec?: CertificateSigningRequestSpec; + +} + +/** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList + */ +export interface CertificateSigningRequestListOptions { + /** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList#items + */ + readonly items: CertificateSigningRequest[]; + + /** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Lease defines a lease concept. + * + * @schema io.k8s.api.coordination.v1.Lease + */ +export interface LeaseOptions { + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.coordination.v1.Lease#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.coordination.v1.Lease#spec + */ + readonly spec?: LeaseSpec; + +} + +/** + * LeaseList is a list of Lease objects. + * + * @schema io.k8s.api.coordination.v1.LeaseList + */ +export interface LeaseListOptions { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.coordination.v1.LeaseList#items + */ + readonly items: Lease[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.coordination.v1.LeaseList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. + * + * @schema io.k8s.api.core.v1.Binding + */ +export interface BindingOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Binding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The target object that you want to bind to the standard object. + * + * @schema io.k8s.api.core.v1.Binding#target + */ + readonly target: ObjectReference; + +} + +/** + * ComponentStatus (and ComponentStatusList) holds the cluster validation info. + * + * @schema io.k8s.api.core.v1.ComponentStatus + */ +export interface ComponentStatusOptions { + /** + * List of component conditions observed + * + * @schema io.k8s.api.core.v1.ComponentStatus#conditions + */ + readonly conditions?: ComponentCondition[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ComponentStatus#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * Status of all the conditions for the component as a list of ComponentStatus objects. + * + * @schema io.k8s.api.core.v1.ComponentStatusList + */ +export interface ComponentStatusListOptions { + /** + * List of ComponentStatus objects. + * + * @schema io.k8s.api.core.v1.ComponentStatusList#items + */ + readonly items: ComponentStatus[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ComponentStatusList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ConfigMap holds configuration data for pods to consume. + * + * @schema io.k8s.api.core.v1.ConfigMap + */ +export interface ConfigMapOptions { + /** + * BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. + * + * @schema io.k8s.api.core.v1.ConfigMap#binaryData + */ + readonly binaryData?: { [key: string]: string }; + + /** + * Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. + * + * @schema io.k8s.api.core.v1.ConfigMap#data + */ + readonly data?: { [key: string]: string }; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ConfigMap#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * ConfigMapList is a resource containing a list of ConfigMap objects. + * + * @schema io.k8s.api.core.v1.ConfigMapList + */ +export interface ConfigMapListOptions { + /** + * Items is the list of ConfigMaps. + * + * @schema io.k8s.api.core.v1.ConfigMapList#items + */ + readonly items: ConfigMap[]; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ConfigMapList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ] + * + * @schema io.k8s.api.core.v1.Endpoints + */ +export interface EndpointsOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Endpoints#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. + * + * @schema io.k8s.api.core.v1.Endpoints#subsets + */ + readonly subsets?: EndpointSubset[]; + +} + +/** + * EndpointsList is a list of endpoints. + * + * @schema io.k8s.api.core.v1.EndpointsList + */ +export interface EndpointsListOptions { + /** + * List of endpoints. + * + * @schema io.k8s.api.core.v1.EndpointsList#items + */ + readonly items: Endpoints[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.EndpointsList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Event is a report of an event somewhere in the cluster. + * + * @schema io.k8s.api.core.v1.Event + */ +export interface EventOptions { + /** + * What action was taken/failed regarding to the Regarding object. + * + * @schema io.k8s.api.core.v1.Event#action + */ + readonly action?: string; + + /** + * The number of times this event has occurred. + * + * @schema io.k8s.api.core.v1.Event#count + */ + readonly count?: number; + + /** + * Time when this Event was first observed. + * + * @schema io.k8s.api.core.v1.Event#eventTime + */ + readonly eventTime?: Date; + + /** + * The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) + * + * @schema io.k8s.api.core.v1.Event#firstTimestamp + */ + readonly firstTimestamp?: Date; + + /** + * The object that this event is about. + * + * @schema io.k8s.api.core.v1.Event#involvedObject + */ + readonly involvedObject: ObjectReference; + + /** + * The time at which the most recent occurrence of this event was recorded. + * + * @schema io.k8s.api.core.v1.Event#lastTimestamp + */ + readonly lastTimestamp?: Date; + + /** + * A human-readable description of the status of this operation. + * + * @schema io.k8s.api.core.v1.Event#message + */ + readonly message?: string; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Event#metadata + */ + readonly metadata: ObjectMeta; + + /** + * This should be a short, machine understandable string that gives the reason for the transition into the object's current status. + * + * @schema io.k8s.api.core.v1.Event#reason + */ + readonly reason?: string; + + /** + * Optional secondary object for more complex actions. + * + * @schema io.k8s.api.core.v1.Event#related + */ + readonly related?: ObjectReference; + + /** + * Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. + * + * @schema io.k8s.api.core.v1.Event#reportingComponent + */ + readonly reportingComponent?: string; + + /** + * ID of the controller instance, e.g. `kubelet-xyzf`. + * + * @schema io.k8s.api.core.v1.Event#reportingInstance + */ + readonly reportingInstance?: string; + + /** + * Data about the Event series this event represents or nil if it's a singleton Event. + * + * @schema io.k8s.api.core.v1.Event#series + */ + readonly series?: EventSeries; + + /** + * The component reporting this event. Should be a short machine understandable string. + * + * @schema io.k8s.api.core.v1.Event#source + */ + readonly source?: EventSource; + + /** + * Type of this event (Normal, Warning), new types could be added in the future + * + * @schema io.k8s.api.core.v1.Event#type + */ + readonly type?: string; + +} + +/** + * EventList is a list of events. + * + * @schema io.k8s.api.core.v1.EventList + */ +export interface EventListOptions { + /** + * List of events + * + * @schema io.k8s.api.core.v1.EventList#items + */ + readonly items: Event[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.EventList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * LimitRange sets resource usage limits for each kind of resource in a Namespace. + * + * @schema io.k8s.api.core.v1.LimitRange + */ +export interface LimitRangeOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.LimitRange#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.LimitRange#spec + */ + readonly spec?: LimitRangeSpec; + +} + +/** + * LimitRangeList is a list of LimitRange items. + * + * @schema io.k8s.api.core.v1.LimitRangeList + */ +export interface LimitRangeListOptions { + /** + * Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ + * + * @schema io.k8s.api.core.v1.LimitRangeList#items + */ + readonly items: LimitRange[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.LimitRangeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Namespace provides a scope for Names. Use of multiple namespaces is optional. + * + * @schema io.k8s.api.core.v1.Namespace + */ +export interface NamespaceOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Namespace#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Namespace#spec + */ + readonly spec?: NamespaceSpec; + +} + +/** + * NamespaceList is a list of Namespaces. + * + * @schema io.k8s.api.core.v1.NamespaceList + */ +export interface NamespaceListOptions { + /** + * Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + * + * @schema io.k8s.api.core.v1.NamespaceList#items + */ + readonly items: Namespace[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.NamespaceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). + * + * @schema io.k8s.api.core.v1.Node + */ +export interface NodeOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Node#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Node#spec + */ + readonly spec?: NodeSpec; + +} + +/** + * NodeList is the whole list of all Nodes which have been registered with master. + * + * @schema io.k8s.api.core.v1.NodeList + */ +export interface NodeListOptions { + /** + * List of nodes + * + * @schema io.k8s.api.core.v1.NodeList#items + */ + readonly items: Node[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.NodeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolume + */ +export interface PersistentVolumeOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PersistentVolume#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolume#spec + */ + readonly spec?: PersistentVolumeSpec; + +} + +/** + * PersistentVolumeClaim is a user's request for and claim to a persistent volume + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim + */ +export interface PersistentVolumeClaimOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim#spec + */ + readonly spec?: PersistentVolumeClaimSpec; + +} + +/** + * PersistentVolumeClaimList is a list of PersistentVolumeClaim items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList + */ +export interface PersistentVolumeClaimListOptions { + /** + * A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList#items + */ + readonly items: PersistentVolumeClaim[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PersistentVolumeList is a list of PersistentVolume items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeList + */ +export interface PersistentVolumeListOptions { + /** + * List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolumeList#items + */ + readonly items: PersistentVolume[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PersistentVolumeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. + * + * @schema io.k8s.api.core.v1.Pod + */ +export interface PodOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Pod#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Pod#spec + */ + readonly spec?: PodSpec; + +} + +/** + * PodList is a list of Pods. + * + * @schema io.k8s.api.core.v1.PodList + */ +export interface PodListOptions { + /** + * List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + * + * @schema io.k8s.api.core.v1.PodList#items + */ + readonly items: Pod[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PodList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PodTemplate describes a template for creating copies of a predefined pod. + * + * @schema io.k8s.api.core.v1.PodTemplate + */ +export interface PodTemplateOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PodTemplate#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.PodTemplate#template + */ + readonly template?: PodTemplateSpec; + +} + +/** + * PodTemplateList is a list of PodTemplates. + * + * @schema io.k8s.api.core.v1.PodTemplateList + */ +export interface PodTemplateListOptions { + /** + * List of pod templates + * + * @schema io.k8s.api.core.v1.PodTemplateList#items + */ + readonly items: PodTemplate[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PodTemplateList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ReplicationController represents the configuration of a replication controller. + * + * @schema io.k8s.api.core.v1.ReplicationController + */ +export interface ReplicationControllerOptions { + /** + * If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ReplicationController#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.ReplicationController#spec + */ + readonly spec?: ReplicationControllerSpec; + +} + +/** + * ReplicationControllerList is a collection of replication controllers. + * + * @schema io.k8s.api.core.v1.ReplicationControllerList + */ +export interface ReplicationControllerListOptions { + /** + * List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller + * + * @schema io.k8s.api.core.v1.ReplicationControllerList#items + */ + readonly items: ReplicationController[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ReplicationControllerList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ResourceQuota sets aggregate quota restrictions enforced per namespace + * + * @schema io.k8s.api.core.v1.ResourceQuota + */ +export interface ResourceQuotaOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ResourceQuota#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.ResourceQuota#spec + */ + readonly spec?: ResourceQuotaSpec; + +} + +/** + * ResourceQuotaList is a list of ResourceQuota items. + * + * @schema io.k8s.api.core.v1.ResourceQuotaList + */ +export interface ResourceQuotaListOptions { + /** + * Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + * + * @schema io.k8s.api.core.v1.ResourceQuotaList#items + */ + readonly items: ResourceQuota[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ResourceQuotaList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + * + * @schema io.k8s.api.core.v1.Secret + */ +export interface SecretOptions { + /** + * Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 + * + * @schema io.k8s.api.core.v1.Secret#data + */ + readonly data?: { [key: string]: string }; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Secret#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. + * + * @schema io.k8s.api.core.v1.Secret#stringData + */ + readonly stringData?: { [key: string]: string }; + + /** + * Used to facilitate programmatic handling of secret data. + * + * @schema io.k8s.api.core.v1.Secret#type + */ + readonly type?: string; + +} + +/** + * SecretList is a list of Secret. + * + * @schema io.k8s.api.core.v1.SecretList + */ +export interface SecretListOptions { + /** + * Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret + * + * @schema io.k8s.api.core.v1.SecretList#items + */ + readonly items: Secret[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.SecretList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. + * + * @schema io.k8s.api.core.v1.Service + */ +export interface ServiceOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Service#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Service#spec + */ + readonly spec?: ServiceSpec; + +} + +/** + * ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets + * + * @schema io.k8s.api.core.v1.ServiceAccount + */ +export interface ServiceAccountOptions { + /** + * AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. + * + * @schema io.k8s.api.core.v1.ServiceAccount#automountServiceAccountToken + */ + readonly automountServiceAccountToken?: boolean; + + /** + * ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod + * + * @schema io.k8s.api.core.v1.ServiceAccount#imagePullSecrets + */ + readonly imagePullSecrets?: LocalObjectReference[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ServiceAccount#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret + * + * @schema io.k8s.api.core.v1.ServiceAccount#secrets + */ + readonly secrets?: ObjectReference[]; + +} + +/** + * ServiceAccountList is a list of ServiceAccount objects + * + * @schema io.k8s.api.core.v1.ServiceAccountList + */ +export interface ServiceAccountListOptions { + /** + * List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + * + * @schema io.k8s.api.core.v1.ServiceAccountList#items + */ + readonly items: ServiceAccount[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ServiceAccountList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ServiceList holds a list of services. + * + * @schema io.k8s.api.core.v1.ServiceList + */ +export interface ServiceListOptions { + /** + * List of services + * + * @schema io.k8s.api.core.v1.ServiceList#items + */ + readonly items: Service[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ServiceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice + */ +export interface EndpointSliceOptions { + /** + * addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#addressType + */ + readonly addressType: string; + + /** + * endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#endpoints + */ + readonly endpoints: Endpoint[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#ports + */ + readonly ports?: EndpointPort[]; + +} + +/** + * EndpointSliceList represents a list of endpoint slices + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList + */ +export interface EndpointSliceListOptions { + /** + * List of endpoint slices + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList#items + */ + readonly items: EndpointSlice[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + * + * @schema io.k8s.api.networking.v1beta1.Ingress + */ +export interface IngressOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1beta1.Ingress#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.networking.v1beta1.Ingress#spec + */ + readonly spec?: IngressSpec; + +} + +/** + * IngressList is a collection of Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressList + */ +export interface IngressListOptions { + /** + * Items is the list of Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressList#items + */ + readonly items: Ingress[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1beta1.IngressList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * NetworkPolicy describes what network traffic is allowed for a set of Pods + * + * @schema io.k8s.api.networking.v1.NetworkPolicy + */ +export interface NetworkPolicyOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.NetworkPolicy#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior for this NetworkPolicy. + * + * @schema io.k8s.api.networking.v1.NetworkPolicy#spec + */ + readonly spec?: NetworkPolicySpec; + +} + +/** + * NetworkPolicyList is a list of NetworkPolicy objects. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList + */ +export interface NetworkPolicyListOptions { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList#items + */ + readonly items: NetworkPolicy[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy + */ +export interface PodSecurityPolicyOptions { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec defines the policy enforced. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy#spec + */ + readonly spec?: PodSecurityPolicySpec; + +} + +/** + * PodSecurityPolicyList is a list of PodSecurityPolicy objects. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList + */ +export interface PodSecurityPolicyListOptions { + /** + * items is a list of schema objects. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList#items + */ + readonly items: PodSecurityPolicy[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema + */ +export interface FlowSchemaOptions { + /** + * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema#spec + */ + readonly spec?: FlowSchemaSpec; + +} + +/** + * FlowSchemaList is a list of FlowSchema objects. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList + */ +export interface FlowSchemaListOptions { + /** + * `items` is a list of FlowSchemas. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList#items + */ + readonly items: FlowSchema[]; + + /** + * `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PriorityLevelConfiguration represents the configuration of a priority level. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration + */ +export interface PriorityLevelConfigurationOptions { + /** + * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration#spec + */ + readonly spec?: PriorityLevelConfigurationSpec; + +} + +/** + * PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList + */ +export interface PriorityLevelConfigurationListOptions { + /** + * `items` is a list of request-priorities. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList#items + */ + readonly items: PriorityLevelConfiguration[]; + + /** + * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass + */ +export interface RuntimeClassOptions { + /** + * Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must conform to the DNS Label (RFC 1123) requirements, and is immutable. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#handler + */ + readonly handler: string; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#overhead + */ + readonly overhead?: Overhead; + + /** + * Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#scheduling + */ + readonly scheduling?: Scheduling; + +} + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList + */ +export interface RuntimeClassListOptions { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList#items + */ + readonly items: RuntimeClass[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. + * + * @schema io.k8s.api.policy.v1beta1.Eviction + */ +export interface EvictionOptions { + /** + * DeleteOptions may be provided + * + * @schema io.k8s.api.policy.v1beta1.Eviction#deleteOptions + */ + readonly deleteOptions?: DeleteOptions; + + /** + * ObjectMeta describes the pod that is being evicted. + * + * @schema io.k8s.api.policy.v1beta1.Eviction#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget + */ +export interface PodDisruptionBudgetOptions { + /** + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the PodDisruptionBudget. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget#spec + */ + readonly spec?: PodDisruptionBudgetSpec; + +} + +/** + * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList + */ +export interface PodDisruptionBudgetListOptions { + /** + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList#items + */ + readonly items: PodDisruptionBudget[]; + + /** + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + * + * @schema io.k8s.api.rbac.v1.ClusterRole + */ +export interface ClusterRoleOptions { + /** + * AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + * + * @schema io.k8s.api.rbac.v1.ClusterRole#aggregationRule + */ + readonly aggregationRule?: AggregationRule; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRole#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this ClusterRole + * + * @schema io.k8s.api.rbac.v1.ClusterRole#rules + */ + readonly rules?: PolicyRule[]; + +} + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding + */ +export interface ClusterRoleBindingOptions { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#roleRef + */ + readonly roleRef: RoleRef; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#subjects + */ + readonly subjects?: Subject[]; + +} + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList + */ +export interface ClusterRoleBindingListOptions { + /** + * Items is a list of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList#items + */ + readonly items: ClusterRoleBinding[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ClusterRoleList is a collection of ClusterRoles + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList + */ +export interface ClusterRoleListOptions { + /** + * Items is a list of ClusterRoles + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList#items + */ + readonly items: ClusterRole[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + * + * @schema io.k8s.api.rbac.v1.Role + */ +export interface RoleOptions { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.Role#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this Role + * + * @schema io.k8s.api.rbac.v1.Role#rules + */ + readonly rules?: PolicyRule[]; + +} + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. + * + * @schema io.k8s.api.rbac.v1.RoleBinding + */ +export interface RoleBindingOptions { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.RoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1.RoleBinding#roleRef + */ + readonly roleRef: RoleRef; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1.RoleBinding#subjects + */ + readonly subjects?: Subject[]; + +} + +/** + * RoleBindingList is a collection of RoleBindings + * + * @schema io.k8s.api.rbac.v1.RoleBindingList + */ +export interface RoleBindingListOptions { + /** + * Items is a list of RoleBindings + * + * @schema io.k8s.api.rbac.v1.RoleBindingList#items + */ + readonly items: RoleBinding[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.RoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * RoleList is a collection of Roles + * + * @schema io.k8s.api.rbac.v1.RoleList + */ +export interface RoleListOptions { + /** + * Items is a list of Roles + * + * @schema io.k8s.api.rbac.v1.RoleList#items + */ + readonly items: Role[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.RoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass + */ +export interface PriorityClassOptions { + /** + * description is an arbitrary string that usually provides guidelines on when this priority class should be used. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#description + */ + readonly description?: string; + + /** + * globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#globalDefault + */ + readonly globalDefault?: boolean; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. + * + * @default PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. + * @schema io.k8s.api.scheduling.v1.PriorityClass#preemptionPolicy + */ + readonly preemptionPolicy?: string; + + /** + * The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#value + */ + readonly value: number; + +} + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList + */ +export interface PriorityClassListOptions { + /** + * items is the list of PriorityClasses + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList#items + */ + readonly items: PriorityClass[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * PodPreset is a policy resource that defines additional runtime requirements for a Pod. + * + * @schema io.k8s.api.settings.v1alpha1.PodPreset + */ +export interface PodPresetOptions { + /** + * @schema io.k8s.api.settings.v1alpha1.PodPreset#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * @schema io.k8s.api.settings.v1alpha1.PodPreset#spec + */ + readonly spec?: PodPresetSpec; + +} + +/** + * PodPresetList is a list of PodPreset objects. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetList + */ +export interface PodPresetListOptions { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetList#items + */ + readonly items: PodPreset[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + * + * @schema io.k8s.api.storage.v1.CSINode + */ +export interface CsiNodeOptions { + /** + * metadata.name must be the Kubernetes node name. + * + * @schema io.k8s.api.storage.v1.CSINode#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec is the specification of CSINode + * + * @schema io.k8s.api.storage.v1.CSINode#spec + */ + readonly spec: CsiNodeSpec; + +} + +/** + * CSINodeList is a collection of CSINode objects. + * + * @schema io.k8s.api.storage.v1.CSINodeList + */ +export interface CsiNodeListOptions { + /** + * items is the list of CSINode + * + * @schema io.k8s.api.storage.v1.CSINodeList#items + */ + readonly items: CsiNode[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.CSINodeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + * + * @schema io.k8s.api.storage.v1.StorageClass + */ +export interface StorageClassOptions { + /** + * AllowVolumeExpansion shows whether the storage class allow volume expand + * + * @schema io.k8s.api.storage.v1.StorageClass#allowVolumeExpansion + */ + readonly allowVolumeExpansion?: boolean; + + /** + * Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. + * + * @schema io.k8s.api.storage.v1.StorageClass#allowedTopologies + */ + readonly allowedTopologies?: TopologySelectorTerm[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.StorageClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. + * + * @schema io.k8s.api.storage.v1.StorageClass#mountOptions + */ + readonly mountOptions?: string[]; + + /** + * Parameters holds the parameters for the provisioner that should create volumes of this storage class. + * + * @schema io.k8s.api.storage.v1.StorageClass#parameters + */ + readonly parameters?: { [key: string]: string }; + + /** + * Provisioner indicates the type of the provisioner. + * + * @schema io.k8s.api.storage.v1.StorageClass#provisioner + */ + readonly provisioner: string; + + /** + * Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. + * + * @default Delete. + * @schema io.k8s.api.storage.v1.StorageClass#reclaimPolicy + */ + readonly reclaimPolicy?: string; + + /** + * VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. + * + * @schema io.k8s.api.storage.v1.StorageClass#volumeBindingMode + */ + readonly volumeBindingMode?: string; + +} + +/** + * StorageClassList is a collection of storage classes. + * + * @schema io.k8s.api.storage.v1.StorageClassList + */ +export interface StorageClassListOptions { + /** + * Items is the list of StorageClasses + * + * @schema io.k8s.api.storage.v1.StorageClassList#items + */ + readonly items: StorageClass[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.StorageClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1.VolumeAttachment + */ +export interface VolumeAttachmentOptions { + /** + * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.VolumeAttachment#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. + * + * @schema io.k8s.api.storage.v1.VolumeAttachment#spec + */ + readonly spec: VolumeAttachmentSpec; + +} + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList + */ +export interface VolumeAttachmentListOptions { + /** + * Items is the list of VolumeAttachments + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList#items + */ + readonly items: VolumeAttachment[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver + */ +export interface CsiDriverOptions { + /** + * Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the CSI Driver. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver#spec + */ + readonly spec: CsiDriverSpec; + +} + +/** + * CSIDriverList is a collection of CSIDriver objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList + */ +export interface CsiDriverListOptions { + /** + * items is the list of CSIDriver + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList#items + */ + readonly items: CsiDriver[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition + */ +export interface CustomResourceDefinitionOptions { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec describes how the user wants the resources to appear + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition#spec + */ + readonly spec: CustomResourceDefinitionSpec; + +} + +/** + * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList + */ +export interface CustomResourceDefinitionListOptions { + /** + * items list individual CustomResourceDefinition objects + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList#items + */ + readonly items: CustomResourceDefinition[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Status is a return value for calls that don't return other objects. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status + */ +export interface StatusOptions { + /** + * Suggested HTTP return code for this status, 0 if not set. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#code + */ + readonly code?: number; + + /** + * Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#details + */ + readonly details?: StatusDetails; + + /** + * A human-readable description of the status of this operation. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#message + */ + readonly message?: string; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#metadata + */ + readonly metadata?: ListMeta; + + /** + * A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#reason + */ + readonly reason?: string; + +} + +/** + * APIService represents a server for a particular GroupVersion. Name must be "version.group". + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService + */ +export interface ApiServiceOptions { + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec contains information for locating and communicating with a server + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService#spec + */ + readonly spec?: ApiServiceSpec; + +} + +/** + * APIServiceList is a list of APIService objects. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList + */ +export interface ApiServiceListOptions { + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList#items + */ + readonly items: ApiService[]; + + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta + */ +export interface ObjectMeta { + /** + * Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#annotations + */ + readonly annotations?: { [key: string]: string }; + + /** + * The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#clusterName + */ + readonly clusterName?: string; + + /** + * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. + +Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#creationTimestamp + */ + readonly creationTimestamp?: Date; + + /** + * Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#deletionGracePeriodSeconds + */ + readonly deletionGracePeriodSeconds?: number; + + /** + * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. + +Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#deletionTimestamp + */ + readonly deletionTimestamp?: Date; + + /** + * Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#finalizers + */ + readonly finalizers?: string[]; + + /** + * GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. + +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). + +Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#generateName + */ + readonly generateName?: string; + + /** + * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#generation + */ + readonly generation?: number; + + /** + * Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#labels + */ + readonly labels?: { [key: string]: string }; + + /** + * ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#managedFields + */ + readonly managedFields?: ManagedFieldsEntry[]; + + /** + * Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#name + */ + readonly name?: string; + + /** + * Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. + +Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#namespace + */ + readonly namespace?: string; + + /** + * List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#ownerReferences + */ + readonly ownerReferences?: OwnerReference[]; + + /** + * An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. + +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * SelfLink is a URL representing this object. Populated by the system. Read-only. + +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#selfLink + */ + readonly selfLink?: string; + + /** + * UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. + +Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#uid + */ + readonly uid?: string; + +} + +/** + * MutatingWebhook describes an admission webhook and the resources and operations it applies to. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook + */ +export interface MutatingWebhook { + /** + * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#admissionReviewVersions + */ + readonly admissionReviewVersions: string[]; + + /** + * ClientConfig defines how to communicate with the hook. Required + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#clientConfig + */ + readonly clientConfig: WebhookClientConfig; + + /** + * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. + * + * @default Fail. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#failurePolicy + */ + readonly failurePolicy?: string; + + /** + * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + +- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Equivalent" + * + * @default Equivalent" + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#matchPolicy + */ + readonly matchPolicy?: string; + + /** + * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#name + */ + readonly name: string; + + /** + * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { + "matchExpressions": [ + { + "key": "runlevel", + "operator": "NotIn", + "values": [ + "0", + "1" + ] + } + ] +} + +If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { + "matchExpressions": [ + { + "key": "environment", + "operator": "In", + "values": [ + "prod", + "staging" + ] + } + ] +} + +See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#objectSelector + */ + readonly objectSelector?: LabelSelector; + + /** + * reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". + +Never: the webhook will not be called more than once in a single admission evaluation. + +IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. + +Defaults to "Never". + * + * @default Never". + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#reinvocationPolicy + */ + readonly reinvocationPolicy?: string; + + /** + * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#rules + */ + readonly rules?: RuleWithOperations[]; + + /** + * SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#sideEffects + */ + readonly sideEffects: string; + + /** + * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. + * + * @default 10 seconds. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta + */ +export interface ListMeta { + /** + * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#continue + */ + readonly continue?: string; + + /** + * remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#remainingItemCount + */ + readonly remainingItemCount?: number; + + /** + * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to 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 + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * selfLink is a URL representing this object. Populated by the system. Read-only. + +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#selfLink + */ + readonly selfLink?: string; + +} + +/** + * ValidatingWebhook describes an admission webhook and the resources and operations it applies to. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook + */ +export interface ValidatingWebhook { + /** + * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#admissionReviewVersions + */ + readonly admissionReviewVersions: string[]; + + /** + * ClientConfig defines how to communicate with the hook. Required + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#clientConfig + */ + readonly clientConfig: WebhookClientConfig; + + /** + * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. + * + * @default Fail. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#failurePolicy + */ + readonly failurePolicy?: string; + + /** + * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + +- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Equivalent" + * + * @default Equivalent" + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#matchPolicy + */ + readonly matchPolicy?: string; + + /** + * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#name + */ + readonly name: string; + + /** + * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { + "matchExpressions": [ + { + "key": "runlevel", + "operator": "NotIn", + "values": [ + "0", + "1" + ] + } + ] +} + +If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { + "matchExpressions": [ + { + "key": "environment", + "operator": "In", + "values": [ + "prod", + "staging" + ] + } + ] +} + +See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#objectSelector + */ + readonly objectSelector?: LabelSelector; + + /** + * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#rules + */ + readonly rules?: RuleWithOperations[]; + + /** + * SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#sideEffects + */ + readonly sideEffects: string; + + /** + * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. + * + * @default 10 seconds. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * DaemonSetSpec is the specification of a daemon set. + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec + */ +export interface DaemonSetSpec { + /** + * The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). + * + * @default 0 (pod will be considered available as soon as it is ready). + * @schema io.k8s.api.apps.v1.DaemonSetSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. + * + * @default 10. + * @schema io.k8s.api.apps.v1.DaemonSetSpec#revisionHistoryLimit + */ + readonly revisionHistoryLimit?: number; + + /** + * A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec#selector + */ + readonly selector: LabelSelector; + + /** + * An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec#template + */ + readonly template: PodTemplateSpec; + + /** + * An update strategy to replace existing DaemonSet pods with new pods. + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec#updateStrategy + */ + readonly updateStrategy?: DaemonSetUpdateStrategy; + +} + +/** + * DeploymentSpec is the specification of the desired behavior of the Deployment. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec + */ +export interface DeploymentSpec { + /** + * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) + * + * @default 0 (pod will be considered available as soon as it is ready) + * @schema io.k8s.api.apps.v1.DeploymentSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * Indicates that the deployment is paused. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#paused + */ + readonly paused?: boolean; + + /** + * The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. + * + * @default 600s. + * @schema io.k8s.api.apps.v1.DeploymentSpec#progressDeadlineSeconds + */ + readonly progressDeadlineSeconds?: number; + + /** + * Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. + * + * @default 1. + * @schema io.k8s.api.apps.v1.DeploymentSpec#replicas + */ + readonly replicas?: number; + + /** + * The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. + * + * @default 10. + * @schema io.k8s.api.apps.v1.DeploymentSpec#revisionHistoryLimit + */ + readonly revisionHistoryLimit?: number; + + /** + * Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#selector + */ + readonly selector: LabelSelector; + + /** + * The deployment strategy to use to replace existing pods with new ones. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#strategy + */ + readonly strategy?: DeploymentStrategy; + + /** + * Template describes the pods that will be created. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#template + */ + readonly template: PodTemplateSpec; + +} + +/** + * ReplicaSetSpec is the specification of a ReplicaSet. + * + * @schema io.k8s.api.apps.v1.ReplicaSetSpec + */ +export interface ReplicaSetSpec { + /** + * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) + * + * @default 0 (pod will be considered available as soon as it is ready) + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller + * + * @default 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#replicas + */ + readonly replicas?: number; + + /** + * Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#selector + */ + readonly selector: LabelSelector; + + /** + * Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + * + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#template + */ + readonly template?: PodTemplateSpec; + +} + +/** + * A StatefulSetSpec is the specification of a StatefulSet. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec + */ +export interface StatefulSetSpec { + /** + * podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#podManagementPolicy + */ + readonly podManagementPolicy?: string; + + /** + * replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#replicas + */ + readonly replicas?: number; + + /** + * revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#revisionHistoryLimit + */ + readonly revisionHistoryLimit?: number; + + /** + * selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#selector + */ + readonly selector: LabelSelector; + + /** + * serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#serviceName + */ + readonly serviceName: string; + + /** + * template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#template + */ + readonly template: PodTemplateSpec; + + /** + * updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#updateStrategy + */ + readonly updateStrategy?: StatefulSetUpdateStrategy; + + /** + * volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#volumeClaimTemplates + */ + readonly volumeClaimTemplates?: PersistentVolumeClaim[]; + +} + +/** + * ScaleSpec describes the attributes of a scale subresource. + * + * @schema io.k8s.api.autoscaling.v1.ScaleSpec + */ +export interface ScaleSpec { + /** + * desired number of instances for the scaled object. + * + * @schema io.k8s.api.autoscaling.v1.ScaleSpec#replicas + */ + readonly replicas?: number; + +} + +/** + * AuditSinkSpec holds the spec for the audit sink + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkSpec + */ +export interface AuditSinkSpec { + /** + * Policy defines the policy for selecting which events should be sent to the webhook required + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkSpec#policy + */ + readonly policy: Policy; + + /** + * Webhook to send events required + * + * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkSpec#webhook + */ + readonly webhook: Webhook; + +} + +/** + * TokenRequestSpec contains client provided parameters of a token request. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec + */ +export interface TokenRequestSpec { + /** + * Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec#audiences + */ + readonly audiences: string[]; + + /** + * BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec#boundObjectRef + */ + readonly boundObjectRef?: BoundObjectReference; + + /** + * ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec#expirationSeconds + */ + readonly expirationSeconds?: number; + +} + +/** + * TokenReviewSpec is a description of the token authentication request. + * + * @schema io.k8s.api.authentication.v1.TokenReviewSpec + */ +export interface TokenReviewSpec { + /** + * Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. + * + * @schema io.k8s.api.authentication.v1.TokenReviewSpec#audiences + */ + readonly audiences?: string[]; + + /** + * Token is the opaque bearer token. + * + * @schema io.k8s.api.authentication.v1.TokenReviewSpec#token + */ + readonly token?: string; + +} + +/** + * SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec + */ +export interface SubjectAccessReviewSpec { + /** + * Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#extra + */ + readonly extra?: { [key: string]: string[] }; + + /** + * Groups is the groups you're testing for. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#groups + */ + readonly groups?: string[]; + + /** + * NonResourceAttributes describes information for a non-resource access request + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#nonResourceAttributes + */ + readonly nonResourceAttributes?: NonResourceAttributes; + + /** + * ResourceAuthorizationAttributes describes information for a resource access request + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#resourceAttributes + */ + readonly resourceAttributes?: ResourceAttributes; + + /** + * UID information about the requesting user. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#uid + */ + readonly uid?: string; + + /** + * User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#user + */ + readonly user?: string; + +} + +/** + * SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec + */ +export interface SelfSubjectAccessReviewSpec { + /** + * NonResourceAttributes describes information for a non-resource access request + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec#nonResourceAttributes + */ + readonly nonResourceAttributes?: NonResourceAttributes; + + /** + * ResourceAuthorizationAttributes describes information for a resource access request + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec#resourceAttributes + */ + readonly resourceAttributes?: ResourceAttributes; + +} + +/** + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec + */ +export interface SelfSubjectRulesReviewSpec { + /** + * Namespace to evaluate rules for. Required. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec#namespace + */ + readonly namespace?: string; + +} + +/** + * specification of a horizontal pod autoscaler. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec + */ +export interface HorizontalPodAutoscalerSpec { + /** + * upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#maxReplicas + */ + readonly maxReplicas: number; + + /** + * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#minReplicas + */ + readonly minReplicas?: number; + + /** + * reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#scaleTargetRef + */ + readonly scaleTargetRef: CrossVersionObjectReference; + + /** + * target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#targetCPUUtilizationPercentage + */ + readonly targetCPUUtilizationPercentage?: number; + +} + +/** + * JobSpec describes how the job execution will look like. + * + * @schema io.k8s.api.batch.v1.JobSpec + */ +export interface JobSpec { + /** + * Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer + * + * @schema io.k8s.api.batch.v1.JobSpec#activeDeadlineSeconds + */ + readonly activeDeadlineSeconds?: number; + + /** + * Specifies the number of retries before marking this job failed. Defaults to 6 + * + * @default 6 + * @schema io.k8s.api.batch.v1.JobSpec#backoffLimit + */ + readonly backoffLimit?: number; + + /** + * Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + * + * @schema io.k8s.api.batch.v1.JobSpec#completions + */ + readonly completions?: number; + + /** + * manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector + * + * @schema io.k8s.api.batch.v1.JobSpec#manualSelector + */ + readonly manualSelector?: boolean; + + /** + * Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + * + * @schema io.k8s.api.batch.v1.JobSpec#parallelism + */ + readonly parallelism?: number; + + /** + * A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.batch.v1.JobSpec#selector + */ + readonly selector?: LabelSelector; + + /** + * Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + * + * @schema io.k8s.api.batch.v1.JobSpec#template + */ + readonly template: PodTemplateSpec; + + /** + * ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. + * + * @schema io.k8s.api.batch.v1.JobSpec#ttlSecondsAfterFinished + */ + readonly ttlSecondsAfterFinished?: number; + +} + +/** + * CronJobSpec describes how the job execution will look like and when it will actually run. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec + */ +export interface CronJobSpec { + /** + * Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#concurrencyPolicy + */ + readonly concurrencyPolicy?: string; + + /** + * The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. + * + * @default 1. + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#failedJobsHistoryLimit + */ + readonly failedJobsHistoryLimit?: number; + + /** + * Specifies the job that will be created when executing a CronJob. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#jobTemplate + */ + readonly jobTemplate: JobTemplateSpec; + + /** + * The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#schedule + */ + readonly schedule: string; + + /** + * Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#startingDeadlineSeconds + */ + readonly startingDeadlineSeconds?: number; + + /** + * The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. + * + * @default 3. + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#successfulJobsHistoryLimit + */ + readonly successfulJobsHistoryLimit?: number; + + /** + * This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. + * + * @default false. + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#suspend + */ + readonly suspend?: boolean; + +} + +/** + * This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec + */ +export interface CertificateSigningRequestSpec { + /** + * Extra information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#extra + */ + readonly extra?: { [key: string]: string[] }; + + /** + * Group information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#groups + */ + readonly groups?: string[]; + + /** + * Base64-encoded PKCS#10 CSR data + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#request + */ + readonly request: string; + + /** + * UID information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#uid + */ + readonly uid?: string; + + /** + * allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 + https://tools.ietf.org/html/rfc5280#section-4.2.1.12 + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#usages + */ + readonly usages?: string[]; + + /** + * Information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#username + */ + readonly username?: string; + +} + +/** + * LeaseSpec is a specification of a Lease. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec + */ +export interface LeaseSpec { + /** + * acquireTime is a time when the current lease was acquired. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#acquireTime + */ + readonly acquireTime?: Date; + + /** + * holderIdentity contains the identity of the holder of a current lease. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#holderIdentity + */ + readonly holderIdentity?: string; + + /** + * leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#leaseDurationSeconds + */ + readonly leaseDurationSeconds?: number; + + /** + * leaseTransitions is the number of transitions of a lease between holders. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#leaseTransitions + */ + readonly leaseTransitions?: number; + + /** + * renewTime is a time when the current holder of a lease has last updated the lease. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#renewTime + */ + readonly renewTime?: Date; + +} + +/** + * ObjectReference contains enough information to let you inspect or modify the referred object. + * + * @schema io.k8s.api.core.v1.ObjectReference + */ +export interface ObjectReference { + /** + * API version of the referent. + * + * @schema io.k8s.api.core.v1.ObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + * + * @schema io.k8s.api.core.v1.ObjectReference#fieldPath + */ + readonly fieldPath?: string; + + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ObjectReference#kind + */ + readonly kind?: string; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ObjectReference#name + */ + readonly name?: string; + + /** + * Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + * + * @schema io.k8s.api.core.v1.ObjectReference#namespace + */ + readonly namespace?: string; + + /** + * Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + * + * @schema io.k8s.api.core.v1.ObjectReference#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + * + * @schema io.k8s.api.core.v1.ObjectReference#uid + */ + readonly uid?: string; + +} + +/** + * Information about the condition of a component. + * + * @schema io.k8s.api.core.v1.ComponentCondition + */ +export interface ComponentCondition { + /** + * Condition error code for a component. For example, a health check error code. + * + * @schema io.k8s.api.core.v1.ComponentCondition#error + */ + readonly error?: string; + + /** + * Message about the condition for a component. For example, information about a health check. + * + * @schema io.k8s.api.core.v1.ComponentCondition#message + */ + readonly message?: string; + + /** + * Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". + * + * @schema io.k8s.api.core.v1.ComponentCondition#status + */ + readonly status: string; + + /** + * Type of condition for a component. Valid value: "Healthy" + * + * @schema io.k8s.api.core.v1.ComponentCondition#type + */ + readonly type: string; + +} + +/** + * EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ] + * + * @schema io.k8s.api.core.v1.EndpointSubset + */ +export interface EndpointSubset { + /** + * IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. + * + * @schema io.k8s.api.core.v1.EndpointSubset#addresses + */ + readonly addresses?: EndpointAddress[]; + + /** + * IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. + * + * @schema io.k8s.api.core.v1.EndpointSubset#notReadyAddresses + */ + readonly notReadyAddresses?: EndpointAddress[]; + + /** + * Port numbers available on the related IP addresses. + * + * @schema io.k8s.api.core.v1.EndpointSubset#ports + */ + readonly ports?: EndpointPort[]; + +} + +/** + * EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. + * + * @schema io.k8s.api.core.v1.EventSeries + */ +export interface EventSeries { + /** + * Number of occurrences in this series up to the last heartbeat time + * + * @schema io.k8s.api.core.v1.EventSeries#count + */ + readonly count?: number; + + /** + * Time of the last occurrence observed + * + * @schema io.k8s.api.core.v1.EventSeries#lastObservedTime + */ + readonly lastObservedTime?: Date; + + /** + * State of this Series: Ongoing or Finished Deprecated. Planned removal for 1.18 + * + * @schema io.k8s.api.core.v1.EventSeries#state + */ + readonly state?: string; + +} + +/** + * EventSource contains information for an event. + * + * @schema io.k8s.api.core.v1.EventSource + */ +export interface EventSource { + /** + * Component from which the event is generated. + * + * @schema io.k8s.api.core.v1.EventSource#component + */ + readonly component?: string; + + /** + * Node name on which the event is generated. + * + * @schema io.k8s.api.core.v1.EventSource#host + */ + readonly host?: string; + +} + +/** + * LimitRangeSpec defines a min/max usage limit for resources that match on kind. + * + * @schema io.k8s.api.core.v1.LimitRangeSpec + */ +export interface LimitRangeSpec { + /** + * Limits is the list of LimitRangeItem objects that are enforced. + * + * @schema io.k8s.api.core.v1.LimitRangeSpec#limits + */ + readonly limits: LimitRangeItem[]; + +} + +/** + * NamespaceSpec describes the attributes on a Namespace. + * + * @schema io.k8s.api.core.v1.NamespaceSpec + */ +export interface NamespaceSpec { + /** + * Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + * + * @schema io.k8s.api.core.v1.NamespaceSpec#finalizers + */ + readonly finalizers?: string[]; + +} + +/** + * NodeSpec describes the attributes that a node is created with. + * + * @schema io.k8s.api.core.v1.NodeSpec + */ +export interface NodeSpec { + /** + * If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field + * + * @schema io.k8s.api.core.v1.NodeSpec#configSource + */ + readonly configSource?: NodeConfigSource; + + /** + * Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 + * + * @schema io.k8s.api.core.v1.NodeSpec#externalID + */ + readonly externalID?: string; + + /** + * PodCIDR represents the pod IP range assigned to the node. + * + * @schema io.k8s.api.core.v1.NodeSpec#podCIDR + */ + readonly podCIDR?: string; + + /** + * podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. + * + * @schema io.k8s.api.core.v1.NodeSpec#podCIDRs + */ + readonly podCIDRs?: string[]; + + /** + * ID of the node assigned by the cloud provider in the format: :// + * + * @schema io.k8s.api.core.v1.NodeSpec#providerID + */ + readonly providerID?: string; + + /** + * If specified, the node's taints. + * + * @schema io.k8s.api.core.v1.NodeSpec#taints + */ + readonly taints?: Taint[]; + + /** + * Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration + * + * @schema io.k8s.api.core.v1.NodeSpec#unschedulable + */ + readonly unschedulable?: boolean; + +} + +/** + * PersistentVolumeSpec is the specification of a persistent volume. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec + */ +export interface PersistentVolumeSpec { + /** + * AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#accessModes + */ + readonly accessModes?: string[]; + + /** + * AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#awsElasticBlockStore + */ + readonly awsElasticBlockStore?: AwsElasticBlockStoreVolumeSource; + + /** + * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#azureDisk + */ + readonly azureDisk?: AzureDiskVolumeSource; + + /** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#azureFile + */ + readonly azureFile?: AzureFilePersistentVolumeSource; + + /** + * A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#capacity + */ + readonly capacity?: { [key: string]: Quantity }; + + /** + * CephFS represents a Ceph FS mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#cephfs + */ + readonly cephfs?: CephFsPersistentVolumeSource; + + /** + * Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#cinder + */ + readonly cinder?: CinderPersistentVolumeSource; + + /** + * ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#claimRef + */ + readonly claimRef?: ObjectReference; + + /** + * CSI represents storage that is handled by an external CSI driver (Beta feature). + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#csi + */ + readonly csi?: CsiPersistentVolumeSource; + + /** + * FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#fc + */ + readonly fc?: FcVolumeSource; + + /** + * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#flexVolume + */ + readonly flexVolume?: FlexPersistentVolumeSource; + + /** + * Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#flocker + */ + readonly flocker?: FlockerVolumeSource; + + /** + * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#gcePersistentDisk + */ + readonly gcePersistentDisk?: GcePersistentDiskVolumeSource; + + /** + * Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#glusterfs + */ + readonly glusterfs?: GlusterfsPersistentVolumeSource; + + /** + * HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#hostPath + */ + readonly hostPath?: HostPathVolumeSource; + + /** + * ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#iscsi + */ + readonly iscsi?: IscsiPersistentVolumeSource; + + /** + * Local represents directly-attached storage with node affinity + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#local + */ + readonly local?: LocalVolumeSource; + + /** + * A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#mountOptions + */ + readonly mountOptions?: string[]; + + /** + * NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#nfs + */ + readonly nfs?: NfsVolumeSource; + + /** + * NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#nodeAffinity + */ + readonly nodeAffinity?: VolumeNodeAffinity; + + /** + * What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#persistentVolumeReclaimPolicy + */ + readonly persistentVolumeReclaimPolicy?: string; + + /** + * PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#photonPersistentDisk + */ + readonly photonPersistentDisk?: PhotonPersistentDiskVolumeSource; + + /** + * PortworxVolume represents a portworx volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#portworxVolume + */ + readonly portworxVolume?: PortworxVolumeSource; + + /** + * Quobyte represents a Quobyte mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#quobyte + */ + readonly quobyte?: QuobyteVolumeSource; + + /** + * RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#rbd + */ + readonly rbd?: RbdPersistentVolumeSource; + + /** + * ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#scaleIO + */ + readonly scaleIO?: ScaleIoPersistentVolumeSource; + + /** + * Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#storageClassName + */ + readonly storageClassName?: string; + + /** + * StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#storageos + */ + readonly storageos?: StorageOsPersistentVolumeSource; + + /** + * volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is a beta feature. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#volumeMode + */ + readonly volumeMode?: string; + + /** + * VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#vsphereVolume + */ + readonly vsphereVolume?: VsphereVirtualDiskVolumeSource; + +} + +/** + * PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec + */ +export interface PersistentVolumeClaimSpec { + /** + * AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#accessModes + */ + readonly accessModes?: string[]; + + /** + * This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#dataSource + */ + readonly dataSource?: TypedLocalObjectReference; + + /** + * Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#resources + */ + readonly resources?: ResourceRequirements; + + /** + * A label query over volumes to consider for binding. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#selector + */ + readonly selector?: LabelSelector; + + /** + * Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#storageClassName + */ + readonly storageClassName?: string; + + /** + * volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#volumeMode + */ + readonly volumeMode?: string; + + /** + * VolumeName is the binding reference to the PersistentVolume backing this claim. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#volumeName + */ + readonly volumeName?: string; + +} + +/** + * PodSpec is a description of a pod. + * + * @schema io.k8s.api.core.v1.PodSpec + */ +export interface PodSpec { + /** + * Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. + * + * @schema io.k8s.api.core.v1.PodSpec#activeDeadlineSeconds + */ + readonly activeDeadlineSeconds?: number; + + /** + * If specified, the pod's scheduling constraints + * + * @schema io.k8s.api.core.v1.PodSpec#affinity + */ + readonly affinity?: Affinity; + + /** + * AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + * + * @schema io.k8s.api.core.v1.PodSpec#automountServiceAccountToken + */ + readonly automountServiceAccountToken?: boolean; + + /** + * List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. + * + * @schema io.k8s.api.core.v1.PodSpec#containers + */ + readonly containers: Container[]; + + /** + * Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. + * + * @schema io.k8s.api.core.v1.PodSpec#dnsConfig + */ + readonly dnsConfig?: PodDnsConfig; + + /** + * Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + * + * @default ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + * @schema io.k8s.api.core.v1.PodSpec#dnsPolicy + */ + readonly dnsPolicy?: string; + + /** + * EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. + * + * @default true. + * @schema io.k8s.api.core.v1.PodSpec#enableServiceLinks + */ + readonly enableServiceLinks?: boolean; + + /** + * List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. + * + * @schema io.k8s.api.core.v1.PodSpec#ephemeralContainers + */ + readonly ephemeralContainers?: EphemeralContainer[]; + + /** + * HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. + * + * @schema io.k8s.api.core.v1.PodSpec#hostAliases + */ + readonly hostAliases?: HostAlias[]; + + /** + * Use the host's ipc namespace. Optional: Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#hostIPC + */ + readonly hostIPC?: boolean; + + /** + * Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#hostNetwork + */ + readonly hostNetwork?: boolean; + + /** + * Use the host's pid namespace. Optional: Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#hostPID + */ + readonly hostPID?: boolean; + + /** + * Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. + * + * @schema io.k8s.api.core.v1.PodSpec#hostname + */ + readonly hostname?: string; + + /** + * ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + * + * @schema io.k8s.api.core.v1.PodSpec#imagePullSecrets + */ + readonly imagePullSecrets?: LocalObjectReference[]; + + /** + * List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + * + * @schema io.k8s.api.core.v1.PodSpec#initContainers + */ + readonly initContainers?: Container[]; + + /** + * NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. + * + * @schema io.k8s.api.core.v1.PodSpec#nodeName + */ + readonly nodeName?: string; + + /** + * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + * + * @schema io.k8s.api.core.v1.PodSpec#nodeSelector + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. + * + * @schema io.k8s.api.core.v1.PodSpec#overhead + */ + readonly overhead?: { [key: string]: Quantity }; + + /** + * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. + * + * @default PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. + * @schema io.k8s.api.core.v1.PodSpec#preemptionPolicy + */ + readonly preemptionPolicy?: string; + + /** + * The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. + * + * @schema io.k8s.api.core.v1.PodSpec#priority + */ + readonly priority?: number; + + /** + * If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. + * + * @schema io.k8s.api.core.v1.PodSpec#priorityClassName + */ + readonly priorityClassName?: string; + + /** + * If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md + * + * @schema io.k8s.api.core.v1.PodSpec#readinessGates + */ + readonly readinessGates?: PodReadinessGate[]; + + /** + * Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + * + * @default Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + * @schema io.k8s.api.core.v1.PodSpec#restartPolicy + */ + readonly restartPolicy?: string; + + /** + * RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. + * + * @schema io.k8s.api.core.v1.PodSpec#runtimeClassName + */ + readonly runtimeClassName?: string; + + /** + * If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. + * + * @schema io.k8s.api.core.v1.PodSpec#schedulerName + */ + readonly schedulerName?: string; + + /** + * SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. + * + * @default empty. See type description for default values of each field. + * @schema io.k8s.api.core.v1.PodSpec#securityContext + */ + readonly securityContext?: PodSecurityContext; + + /** + * DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. + * + * @schema io.k8s.api.core.v1.PodSpec#serviceAccount + */ + readonly serviceAccount?: string; + + /** + * ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + * + * @schema io.k8s.api.core.v1.PodSpec#serviceAccountName + */ + readonly serviceAccountName?: string; + + /** + * Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#shareProcessNamespace + */ + readonly shareProcessNamespace?: boolean; + + /** + * If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. + * + * @schema io.k8s.api.core.v1.PodSpec#subdomain + */ + readonly subdomain?: string; + + /** + * Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. + * + * @default 30 seconds. + * @schema io.k8s.api.core.v1.PodSpec#terminationGracePeriodSeconds + */ + readonly terminationGracePeriodSeconds?: number; + + /** + * If specified, the pod's tolerations. + * + * @schema io.k8s.api.core.v1.PodSpec#tolerations + */ + readonly tolerations?: Toleration[]; + + /** + * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. + * + * @schema io.k8s.api.core.v1.PodSpec#topologySpreadConstraints + */ + readonly topologySpreadConstraints?: TopologySpreadConstraint[]; + + /** + * List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes + * + * @schema io.k8s.api.core.v1.PodSpec#volumes + */ + readonly volumes?: Volume[]; + +} + +/** + * PodTemplateSpec describes the data a pod should have when created from a template + * + * @schema io.k8s.api.core.v1.PodTemplateSpec + */ +export interface PodTemplateSpec { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PodTemplateSpec#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.PodTemplateSpec#spec + */ + readonly spec?: PodSpec; + +} + +/** + * ReplicationControllerSpec is the specification of a replication controller. + * + * @schema io.k8s.api.core.v1.ReplicationControllerSpec + */ +export interface ReplicationControllerSpec { + /** + * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) + * + * @default 0 (pod will be considered available as soon as it is ready) + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + * + * @default 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#replicas + */ + readonly replicas?: number; + + /** + * Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#selector + */ + readonly selector?: { [key: string]: string }; + + /** + * Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + * + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#template + */ + readonly template?: PodTemplateSpec; + +} + +/** + * ResourceQuotaSpec defines the desired hard limits to enforce for Quota. + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec + */ +export interface ResourceQuotaSpec { + /** + * hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec#hard + */ + readonly hard?: { [key: string]: Quantity }; + + /** + * scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec#scopeSelector + */ + readonly scopeSelector?: ScopeSelector; + + /** + * A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec#scopes + */ + readonly scopes?: string[]; + +} + +/** + * ServiceSpec describes the attributes that a user creates on a service. + * + * @schema io.k8s.api.core.v1.ServiceSpec + */ +export interface ServiceSpec { + /** + * clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @schema io.k8s.api.core.v1.ServiceSpec#clusterIP + */ + readonly clusterIP?: string; + + /** + * externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. + * + * @schema io.k8s.api.core.v1.ServiceSpec#externalIPs + */ + readonly externalIPs?: string[]; + + /** + * externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName. + * + * @schema io.k8s.api.core.v1.ServiceSpec#externalName + */ + readonly externalName?: string; + + /** + * externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. + * + * @schema io.k8s.api.core.v1.ServiceSpec#externalTrafficPolicy + */ + readonly externalTrafficPolicy?: string; + + /** + * healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. + * + * @schema io.k8s.api.core.v1.ServiceSpec#healthCheckNodePort + */ + readonly healthCheckNodePort?: number; + + /** + * ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster's primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment. + * + * @schema io.k8s.api.core.v1.ServiceSpec#ipFamily + */ + readonly ipFamily?: string; + + /** + * Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. + * + * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerIP + */ + readonly loadBalancerIP?: string; + + /** + * If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ + * + * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerSourceRanges + */ + readonly loadBalancerSourceRanges?: string[]; + + /** + * The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @schema io.k8s.api.core.v1.ServiceSpec#ports + */ + readonly ports?: ServicePort[]; + + /** + * publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. + * + * @schema io.k8s.api.core.v1.ServiceSpec#publishNotReadyAddresses + */ + readonly publishNotReadyAddresses?: boolean; + + /** + * Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ + * + * @schema io.k8s.api.core.v1.ServiceSpec#selector + */ + readonly selector?: { [key: string]: string }; + + /** + * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @default None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * @schema io.k8s.api.core.v1.ServiceSpec#sessionAffinity + */ + readonly sessionAffinity?: string; + + /** + * sessionAffinityConfig contains the configurations of session affinity. + * + * @schema io.k8s.api.core.v1.ServiceSpec#sessionAffinityConfig + */ + readonly sessionAffinityConfig?: SessionAffinityConfig; + + /** + * topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. + * + * @schema io.k8s.api.core.v1.ServiceSpec#topologyKeys + */ + readonly topologyKeys?: string[]; + + /** + * type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + * + * @default ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + * @schema io.k8s.api.core.v1.ServiceSpec#type + */ + readonly type?: string; + +} + +/** + * LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + * + * @schema io.k8s.api.core.v1.LocalObjectReference + */ +export interface LocalObjectReference { + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.LocalObjectReference#name + */ + readonly name?: string; + +} + +/** + * Endpoint represents a single logical "backend" implementing a service. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint + */ +export interface Endpoint { + /** + * addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#addresses + */ + readonly addresses: string[]; + + /** + * conditions contains information about the current status of the endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#conditions + */ + readonly conditions?: EndpointConditions; + + /** + * hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must pass DNS Label (RFC 1123) validation. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#hostname + */ + readonly hostname?: string; + + /** + * targetRef is a reference to a Kubernetes object that represents this endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#targetRef + */ + readonly targetRef?: ObjectReference; + + /** + * topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node + where the endpoint is located. This should match the corresponding + node label. +* topology.kubernetes.io/zone: the value indicates the zone where the + endpoint is located. This should match the corresponding node label. +* topology.kubernetes.io/region: the value indicates the region where the + endpoint is located. This should match the corresponding node label. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#topology + */ + readonly topology?: { [key: string]: string }; + +} + +/** + * EndpointPort is a tuple that describes a single port. + * + * @schema io.k8s.api.core.v1.EndpointPort + */ +export interface EndpointPort { + /** + * The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. + * + * @schema io.k8s.api.core.v1.EndpointPort#name + */ + readonly name?: string; + + /** + * The port number of the endpoint. + * + * @schema io.k8s.api.core.v1.EndpointPort#port + */ + readonly port: number; + + /** + * The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. + * + * @default TCP. + * @schema io.k8s.api.core.v1.EndpointPort#protocol + */ + readonly protocol?: string; + +} + +/** + * IngressSpec describes the Ingress the user wishes to exist. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec + */ +export interface IngressSpec { + /** + * A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#backend + */ + readonly backend?: IngressBackend; + + /** + * A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#rules + */ + readonly rules?: IngressRule[]; + + /** + * TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#tls + */ + readonly tls?: IngressTls[]; + +} + +/** + * NetworkPolicySpec provides the specification of a NetworkPolicy + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec + */ +export interface NetworkPolicySpec { + /** + * List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#egress + */ + readonly egress?: NetworkPolicyEgressRule[]; + + /** + * List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#ingress + */ + readonly ingress?: NetworkPolicyIngressRule[]; + + /** + * Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#podSelector + */ + readonly podSelector: LabelSelector; + + /** + * List of rule types that the NetworkPolicy relates to. Valid options are "Ingress", "Egress", or "Ingress,Egress". If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#policyTypes + */ + readonly policyTypes?: string[]; + +} + +/** + * PodSecurityPolicySpec defines the policy enforced. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec + */ +export interface PodSecurityPolicySpec { + /** + * allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowPrivilegeEscalation + */ + readonly allowPrivilegeEscalation?: boolean; + + /** + * AllowedCSIDrivers is a whitelist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is an alpha field, and is only honored if the API server enables the CSIInlineVolume feature gate. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedCSIDrivers + */ + readonly allowedCSIDrivers?: AllowedCsiDriver[]; + + /** + * allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedCapabilities + */ + readonly allowedCapabilities?: string[]; + + /** + * allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedFlexVolumes + */ + readonly allowedFlexVolumes?: AllowedFlexVolume[]; + + /** + * allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedHostPaths + */ + readonly allowedHostPaths?: AllowedHostPath[]; + + /** + * AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedProcMountTypes + */ + readonly allowedProcMountTypes?: string[]; + + /** + * allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. + +Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedUnsafeSysctls + */ + readonly allowedUnsafeSysctls?: string[]; + + /** + * defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#defaultAddCapabilities + */ + readonly defaultAddCapabilities?: string[]; + + /** + * defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#defaultAllowPrivilegeEscalation + */ + readonly defaultAllowPrivilegeEscalation?: boolean; + + /** + * forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. + +Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#forbiddenSysctls + */ + readonly forbiddenSysctls?: string[]; + + /** + * fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#fsGroup + */ + readonly fsGroup: FsGroupStrategyOptions; + + /** + * hostIPC determines if the policy allows the use of HostIPC in the pod spec. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostIPC + */ + readonly hostIPC?: boolean; + + /** + * hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostNetwork + */ + readonly hostNetwork?: boolean; + + /** + * hostPID determines if the policy allows the use of HostPID in the pod spec. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostPID + */ + readonly hostPID?: boolean; + + /** + * hostPorts determines which host port ranges are allowed to be exposed. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostPorts + */ + readonly hostPorts?: HostPortRange[]; + + /** + * privileged determines if a pod can request to be run as privileged. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#privileged + */ + readonly privileged?: boolean; + + /** + * readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#readOnlyRootFilesystem + */ + readonly readOnlyRootFilesystem?: boolean; + + /** + * requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#requiredDropCapabilities + */ + readonly requiredDropCapabilities?: string[]; + + /** + * RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runAsGroup + */ + readonly runAsGroup?: RunAsGroupStrategyOptions; + + /** + * runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runAsUser + */ + readonly runAsUser: RunAsUserStrategyOptions; + + /** + * runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runtimeClass + */ + readonly runtimeClass?: RuntimeClassStrategyOptions; + + /** + * seLinux is the strategy that will dictate the allowable labels that may be set. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#seLinux + */ + readonly seLinux: SeLinuxStrategyOptions; + + /** + * supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#supplementalGroups + */ + readonly supplementalGroups: SupplementalGroupsStrategyOptions; + + /** + * volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#volumes + */ + readonly volumes?: string[]; + +} + +/** + * FlowSchemaSpec describes how the FlowSchema's specification looks like. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec + */ +export interface FlowSchemaSpec { + /** + * `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#distinguisherMethod + */ + readonly distinguisherMethod?: FlowDistinguisherMethod; + + /** + * `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be non-negative. Note that if the precedence is not specified or zero, it will be set to 1000 as default. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#matchingPrecedence + */ + readonly matchingPrecedence?: number; + + /** + * `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#priorityLevelConfiguration + */ + readonly priorityLevelConfiguration: PriorityLevelConfigurationReference; + + /** + * `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#rules + */ + readonly rules?: PolicyRulesWithSubjects[]; + +} + +/** + * PriorityLevelConfigurationSpec specifies the configuration of a priority level. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationSpec + */ +export interface PriorityLevelConfigurationSpec { + /** + * `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationSpec#limited + */ + readonly limited?: LimitedPriorityLevelConfiguration; + + /** + * `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationSpec#type + */ + readonly type: string; + +} + +/** + * Overhead structure represents the resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1beta1.Overhead + */ +export interface Overhead { + /** + * PodFixed represents the fixed resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1beta1.Overhead#podFixed + */ + readonly podFixed?: { [key: string]: Quantity }; + +} + +/** + * Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + * + * @schema io.k8s.api.node.v1beta1.Scheduling + */ +export interface Scheduling { + /** + * nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + * + * @schema io.k8s.api.node.v1beta1.Scheduling#nodeSelector + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + * + * @schema io.k8s.api.node.v1beta1.Scheduling#tolerations + */ + readonly tolerations?: Toleration[]; + +} + +/** + * DeleteOptions may be provided when deleting an API object. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions + */ +export interface DeleteOptions { + /** + * APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#apiVersion + */ + readonly apiVersion?: string; + + /** + * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#dryRun + */ + readonly dryRun?: string[]; + + /** + * The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. + * + * @default a per object value if not specified. zero means delete immediately. + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#gracePeriodSeconds + */ + readonly gracePeriodSeconds?: number; + + /** + * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#kind + */ + readonly kind?: IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind; + + /** + * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#orphanDependents + */ + readonly orphanDependents?: boolean; + + /** + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#preconditions + */ + readonly preconditions?: Preconditions; + + /** + * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#propagationPolicy + */ + readonly propagationPolicy?: string; + +} + +/** + * PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec + */ +export interface PodDisruptionBudgetSpec { + /** + * An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + + /** + * An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#minAvailable + */ + readonly minAvailable?: IntOrString; + + /** + * Label query over pods whose evictions are managed by the disruption budget. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#selector + */ + readonly selector?: LabelSelector; + +} + +/** + * AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole + * + * @schema io.k8s.api.rbac.v1.AggregationRule + */ +export interface AggregationRule { + /** + * ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added + * + * @schema io.k8s.api.rbac.v1.AggregationRule#clusterRoleSelectors + */ + readonly clusterRoleSelectors?: LabelSelector[]; + +} + +/** + * PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + * + * @schema io.k8s.api.rbac.v1.PolicyRule + */ +export interface PolicyRule { + /** + * APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#nonResourceURLs + */ + readonly nonResourceURLs?: string[]; + + /** + * ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#resourceNames + */ + readonly resourceNames?: string[]; + + /** + * Resources is a list of resources this rule applies to. ResourceAll represents all resources. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#resources + */ + readonly resources?: string[]; + + /** + * Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * RoleRef contains information that points to the role being used + * + * @schema io.k8s.api.rbac.v1.RoleRef + */ +export interface RoleRef { + /** + * APIGroup is the group for the resource being referenced + * + * @schema io.k8s.api.rbac.v1.RoleRef#apiGroup + */ + readonly apiGroup: string; + + /** + * Kind is the type of resource being referenced + * + * @schema io.k8s.api.rbac.v1.RoleRef#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced + * + * @schema io.k8s.api.rbac.v1.RoleRef#name + */ + readonly name: string; + +} + +/** + * Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. + * + * @schema io.k8s.api.rbac.v1.Subject + */ +export interface Subject { + /** + * APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + * + * @default for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + * @schema io.k8s.api.rbac.v1.Subject#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1.Subject#kind + */ + readonly kind: string; + + /** + * Name of the object being referenced. + * + * @schema io.k8s.api.rbac.v1.Subject#name + */ + readonly name: string; + + /** + * Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1.Subject#namespace + */ + readonly namespace?: string; + +} + +/** + * PodPresetSpec is a description of a pod preset. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec + */ +export interface PodPresetSpec { + /** + * Env defines the collection of EnvVar to inject into containers. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#env + */ + readonly env?: EnvVar[]; + + /** + * EnvFrom defines the collection of EnvFromSource to inject into containers. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#envFrom + */ + readonly envFrom?: EnvFromSource[]; + + /** + * Selector is a label query over a set of resources, in this case pods. Required. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#selector + */ + readonly selector?: LabelSelector; + + /** + * VolumeMounts defines the collection of VolumeMount to inject into containers. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#volumeMounts + */ + readonly volumeMounts?: VolumeMount[]; + + /** + * Volumes defines the collection of Volume to inject into the pod. + * + * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#volumes + */ + readonly volumes?: Volume[]; + +} + +/** + * CSINodeSpec holds information about the specification of all CSI drivers installed on a node + * + * @schema io.k8s.api.storage.v1.CSINodeSpec + */ +export interface CsiNodeSpec { + /** + * drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. + * + * @schema io.k8s.api.storage.v1.CSINodeSpec#drivers + */ + readonly drivers: CsiNodeDriver[]; + +} + +/** + * A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. + * + * @schema io.k8s.api.core.v1.TopologySelectorTerm + */ +export interface TopologySelectorTerm { + /** + * A list of topology selector requirements by labels. + * + * @schema io.k8s.api.core.v1.TopologySelectorTerm#matchLabelExpressions + */ + readonly matchLabelExpressions?: TopologySelectorLabelRequirement[]; + +} + +/** + * VolumeAttachmentSpec is the specification of a VolumeAttachment request. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec + */ +export interface VolumeAttachmentSpec { + /** + * Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#attacher + */ + readonly attacher: string; + + /** + * The node that the volume should be attached to. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#nodeName + */ + readonly nodeName: string; + + /** + * Source represents the volume that should be attached. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#source + */ + readonly source: VolumeAttachmentSource; + +} + +/** + * CSIDriverSpec is the specification of a CSIDriver. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec + */ +export interface CsiDriverSpec { + /** + * attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#attachRequired + */ + readonly attachRequired?: boolean; + + /** + * If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume + defined by a CSIVolumeSource, otherwise "false" + +"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. + * + * @default false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#podInfoOnMount + */ + readonly podInfoOnMount?: boolean; + + /** + * VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#volumeLifecycleModes + */ + readonly volumeLifecycleModes?: string[]; + +} + +/** + * CustomResourceDefinitionSpec describes how a user wants their resource to appear + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec + */ +export interface CustomResourceDefinitionSpec { + /** + * conversion defines conversion settings for the CRD. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#conversion + */ + readonly conversion?: CustomResourceConversion; + + /** + * group is the API group of the defined custom resource. The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#group + */ + readonly group: string; + + /** + * names specify the resource and kind names for the custom resource. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#names + */ + readonly names: CustomResourceDefinitionNames; + + /** + * preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#preserveUnknownFields + */ + readonly preserveUnknownFields?: boolean; + + /** + * scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#scope + */ + readonly scope: string; + + /** + * versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#versions + */ + readonly versions: CustomResourceDefinitionVersion[]; + +} + +/** + * StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails + */ +export interface StatusDetails { + /** + * The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#causes + */ + readonly causes?: StatusCause[]; + + /** + * The group attribute of the resource associated with the status StatusReason. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#group + */ + readonly group?: string; + + /** + * The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#kind + */ + readonly kind?: string; + + /** + * The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#name + */ + readonly name?: string; + + /** + * If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#retryAfterSeconds + */ + readonly retryAfterSeconds?: number; + + /** + * UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#uid + */ + readonly uid?: string; + +} + +/** + * APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec + */ +export interface ApiServiceSpec { + /** + * CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#caBundle + */ + readonly caBundle?: string; + + /** + * Group is the API group name this server hosts + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#group + */ + readonly group?: string; + + /** + * GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#groupPriorityMinimum + */ + readonly groupPriorityMinimum: number; + + /** + * InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#insecureSkipTLSVerify + */ + readonly insecureSkipTLSVerify?: boolean; + + /** + * Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#service + */ + readonly service: ServiceReference; + + /** + * Version is the API version this server hosts. For example, "v1" + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#version + */ + readonly version?: string; + + /** + * VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#versionPriority + */ + readonly versionPriority: number; + +} + +/** + * ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry + */ +export interface ManagedFieldsEntry { + /** + * APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#apiVersion + */ + readonly apiVersion?: string; + + /** + * FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#fieldsType + */ + readonly fieldsType?: string; + + /** + * FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#fieldsV1 + */ + readonly fieldsV1?: any; + + /** + * Manager is an identifier of the workflow managing these fields. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#manager + */ + readonly manager?: string; + + /** + * Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#operation + */ + readonly operation?: string; + + /** + * Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#time + */ + readonly time?: Date; + +} + +/** + * OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference + */ +export interface OwnerReference { + /** + * API version of the referent. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#apiVersion + */ + readonly apiVersion: string; + + /** + * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + * + * @default false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#blockOwnerDeletion + */ + readonly blockOwnerDeletion?: boolean; + + /** + * If true, this reference points to the managing controller. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#controller + */ + readonly controller?: boolean; + + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#kind + */ + readonly kind: string; + + /** + * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#name + */ + readonly name: string; + + /** + * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#uid + */ + readonly uid: string; + +} + +/** + * WebhookClientConfig contains the information to make a TLS connection with the webhook + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig + */ +export interface WebhookClientConfig { + /** + * `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#caBundle + */ + readonly caBundle?: string; + + /** + * `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#service + */ + readonly service?: ServiceReference; + + /** + * `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. + +The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. + +Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. + +The scheme must be "https"; the URL must begin with "https://". + +A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. + +Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#url + */ + readonly url?: string; + +} + +/** + * A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector + */ +export interface LabelSelector { + /** + * matchExpressions is a list of label selector requirements. The requirements are ANDed. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector#matchExpressions + */ + readonly matchExpressions?: LabelSelectorRequirement[]; + + /** + * matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector#matchLabels + */ + readonly matchLabels?: { [key: string]: string }; + +} + +/** + * RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations + */ +export interface RuleWithOperations { + /** + * APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#apiVersions + */ + readonly apiVersions?: string[]; + + /** + * Operations is the operations the admission hook cares about - CREATE, UPDATE, or * for all operations. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#operations + */ + readonly operations?: string[]; + + /** + * Resources is a list of resources this rule applies to. + +For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. + +If wildcard is present, the validation rule will ensure resources do not overlap with each other. + +Depending on the enclosing object, subresources might not be allowed. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#resources + */ + readonly resources?: string[]; + + /** + * scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". + * + * @default . + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#scope + */ + readonly scope?: string; + +} + +/** + * DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. + * + * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy + */ +export interface DaemonSetUpdateStrategy { + /** + * Rolling update config params. Present only if type = "RollingUpdate". + * + * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy#rollingUpdate + */ + readonly rollingUpdate?: RollingUpdateDaemonSet; + + /** + * Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. + * + * @default RollingUpdate. + * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy#type + */ + readonly type?: string; + +} + +/** + * DeploymentStrategy describes how to replace existing pods with new ones. + * + * @schema io.k8s.api.apps.v1.DeploymentStrategy + */ +export interface DeploymentStrategy { + /** + * Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. + * + * @schema io.k8s.api.apps.v1.DeploymentStrategy#rollingUpdate + */ + readonly rollingUpdate?: RollingUpdateDeployment; + + /** + * Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. + * + * @default RollingUpdate. + * @schema io.k8s.api.apps.v1.DeploymentStrategy#type + */ + readonly type?: string; + +} + +/** + * StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy. + * + * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy + */ +export interface StatefulSetUpdateStrategy { + /** + * RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. + * + * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy#rollingUpdate + */ + readonly rollingUpdate?: RollingUpdateStatefulSetStrategy; + + /** + * Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. + * + * @default RollingUpdate. + * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy#type + */ + readonly type?: string; + +} + +/** + * Policy defines the configuration of how audit events are logged + * + * @schema io.k8s.api.auditregistration.v1alpha1.Policy + */ +export interface Policy { + /** + * The Level that all requests are recorded at. available options: None, Metadata, Request, RequestResponse required + * + * @schema io.k8s.api.auditregistration.v1alpha1.Policy#level + */ + readonly level: string; + + /** + * Stages is a list of stages for which events are created. + * + * @schema io.k8s.api.auditregistration.v1alpha1.Policy#stages + */ + readonly stages?: string[]; + +} + +/** + * Webhook holds the configuration of the webhook + * + * @schema io.k8s.api.auditregistration.v1alpha1.Webhook + */ +export interface Webhook { + /** + * ClientConfig holds the connection parameters for the webhook required + * + * @schema io.k8s.api.auditregistration.v1alpha1.Webhook#clientConfig + */ + readonly clientConfig: WebhookClientConfig; + + /** + * Throttle holds the options for throttling the webhook + * + * @schema io.k8s.api.auditregistration.v1alpha1.Webhook#throttle + */ + readonly throttle?: WebhookThrottleConfig; + +} + +/** + * BoundObjectReference is a reference to an object that a token is bound to. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference + */ +export interface BoundObjectReference { + /** + * API version of the referent. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of the referent. Valid kinds are 'Pod' and 'Secret'. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#kind + */ + readonly kind?: string; + + /** + * Name of the referent. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#name + */ + readonly name?: string; + + /** + * UID of the referent. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#uid + */ + readonly uid?: string; + +} + +/** + * NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface + * + * @schema io.k8s.api.authorization.v1.NonResourceAttributes + */ +export interface NonResourceAttributes { + /** + * Path is the URL path of the request + * + * @schema io.k8s.api.authorization.v1.NonResourceAttributes#path + */ + readonly path?: string; + + /** + * Verb is the standard HTTP verb + * + * @schema io.k8s.api.authorization.v1.NonResourceAttributes#verb + */ + readonly verb?: string; + +} + +/** + * ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes + */ +export interface ResourceAttributes { + /** + * Group is the API Group of the Resource. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#group + */ + readonly group?: string; + + /** + * Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#name + */ + readonly name?: string; + + /** + * Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#namespace + */ + readonly namespace?: string; + + /** + * Resource is one of the existing resource types. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#resource + */ + readonly resource?: string; + + /** + * Subresource is one of the existing resource types. "" means none. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#subresource + */ + readonly subresource?: string; + + /** + * Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#verb + */ + readonly verb?: string; + + /** + * Version is the API Version of the Resource. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#version + */ + readonly version?: string; + +} + +/** + * CrossVersionObjectReference contains enough information to let you identify the referred resource. + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference + */ +export interface CrossVersionObjectReference { + /** + * API version of the referent + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#kind + */ + readonly kind: string; + + /** + * Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#name + */ + readonly name: string; + +} + +/** + * JobTemplateSpec describes the data a Job should have when created from a template + * + * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec + */ +export interface JobTemplateSpec { + /** + * Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec#spec + */ + readonly spec?: JobSpec; + +} + +/** + * EndpointAddress is a tuple that describes single IP address. + * + * @schema io.k8s.api.core.v1.EndpointAddress + */ +export interface EndpointAddress { + /** + * The Hostname of this endpoint + * + * @schema io.k8s.api.core.v1.EndpointAddress#hostname + */ + readonly hostname?: string; + + /** + * The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. + * + * @schema io.k8s.api.core.v1.EndpointAddress#ip + */ + readonly ip: string; + + /** + * Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. + * + * @schema io.k8s.api.core.v1.EndpointAddress#nodeName + */ + readonly nodeName?: string; + + /** + * Reference to object providing the endpoint. + * + * @schema io.k8s.api.core.v1.EndpointAddress#targetRef + */ + readonly targetRef?: ObjectReference; + +} + +/** + * LimitRangeItem defines a min/max usage limit for any resource that matches on kind. + * + * @schema io.k8s.api.core.v1.LimitRangeItem + */ +export interface LimitRangeItem { + /** + * Default resource requirement limit value by resource name if resource limit is omitted. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#default + */ + readonly default?: { [key: string]: Quantity }; + + /** + * DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#defaultRequest + */ + readonly defaultRequest?: { [key: string]: Quantity }; + + /** + * Max usage constraints on this kind by resource name. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#max + */ + readonly max?: { [key: string]: Quantity }; + + /** + * MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#maxLimitRequestRatio + */ + readonly maxLimitRequestRatio?: { [key: string]: Quantity }; + + /** + * Min usage constraints on this kind by resource name. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#min + */ + readonly min?: { [key: string]: Quantity }; + + /** + * Type of resource that this limit applies to. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#type + */ + readonly type?: string; + +} + +/** + * NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. + * + * @schema io.k8s.api.core.v1.NodeConfigSource + */ +export interface NodeConfigSource { + /** + * ConfigMap is a reference to a Node's ConfigMap + * + * @schema io.k8s.api.core.v1.NodeConfigSource#configMap + */ + readonly configMap?: ConfigMapNodeConfigSource; + +} + +/** + * The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. + * + * @schema io.k8s.api.core.v1.Taint + */ +export interface Taint { + /** + * Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. + * + * @schema io.k8s.api.core.v1.Taint#effect + */ + readonly effect: string; + + /** + * Required. The taint key to be applied to a node. + * + * @schema io.k8s.api.core.v1.Taint#key + */ + readonly key: string; + + /** + * TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. + * + * @schema io.k8s.api.core.v1.Taint#timeAdded + */ + readonly timeAdded?: Date; + + /** + * Required. The taint value corresponding to the taint key. + * + * @schema io.k8s.api.core.v1.Taint#value + */ + readonly value?: string; + +} + +/** + * Represents a Persistent Disk resource in AWS. + +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. + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource + */ +export interface AwsElasticBlockStoreVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#partition + */ + readonly partition?: number; + + /** + * Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#volumeID + */ + readonly volumeID: string; + +} + +/** + * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource + */ +export interface AzureDiskVolumeSource { + /** + * Host Caching mode: None, Read Only, Read Write. + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#cachingMode + */ + readonly cachingMode?: string; + + /** + * The Name of the data disk in the blob storage + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#diskName + */ + readonly diskName: string; + + /** + * The URI the data disk in the blob storage + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#diskURI + */ + readonly diskURI: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#kind + */ + readonly kind?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource + */ +export interface AzureFilePersistentVolumeSource { + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * the name of secret that contains Azure Storage Account Name and Key + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#secretName + */ + readonly secretName: string; + + /** + * the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#secretNamespace + */ + readonly secretNamespace?: string; + + /** + * Share Name + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#shareName + */ + readonly shareName: string; + +} + +/** + * @schema io.k8s.apimachinery.pkg.api.resource.Quantity + */ +export class Quantity { + public static fromString(value: string): Quantity { + return new Quantity(value); + } + public static fromNumber(value: number): Quantity { + return new Quantity(value); + } + private constructor(value: any) { + Object.defineProperty(this, 'resolve', { value: () => value }); + } +} + +/** + * Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource + */ +export interface CephFsPersistentVolumeSource { + /** + * Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * Optional: Used as the mounted root, rather than the full Ceph tree, default is / + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#path + */ + readonly path?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#secretFile + */ + readonly secretFile?: string; + + /** + * Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#user + */ + readonly user?: string; + +} + +/** + * Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource + */ +export interface CinderPersistentVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: points to a secret object containing parameters used to connect to OpenStack. + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#volumeID + */ + readonly volumeID: string; + +} + +/** + * Represents storage that is managed by an external CSI volume driver (Beta feature) + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource + */ +export interface CsiPersistentVolumeSource { + /** + * ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#controllerExpandSecretRef + */ + readonly controllerExpandSecretRef?: SecretReference; + + /** + * ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#controllerPublishSecretRef + */ + readonly controllerPublishSecretRef?: SecretReference; + + /** + * Driver is the name of the driver to use for this volume. Required. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#nodePublishSecretRef + */ + readonly nodePublishSecretRef?: SecretReference; + + /** + * NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#nodeStageSecretRef + */ + readonly nodeStageSecretRef?: SecretReference; + + /** + * Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). + * + * @default false (read/write). + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Attributes of the volume to publish. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#volumeAttributes + */ + readonly volumeAttributes?: { [key: string]: string }; + + /** + * VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#volumeHandle + */ + readonly volumeHandle: string; + +} + +/** + * Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.FCVolumeSource + */ +export interface FcVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.FCVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: FC target lun number + * + * @schema io.k8s.api.core.v1.FCVolumeSource#lun + */ + readonly lun?: number; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.FCVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: FC target worldwide names (WWNs) + * + * @schema io.k8s.api.core.v1.FCVolumeSource#targetWWNs + */ + readonly targetWWNs?: string[]; + + /** + * Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + * + * @schema io.k8s.api.core.v1.FCVolumeSource#wwids + */ + readonly wwids?: string[]; + +} + +/** + * FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource + */ +export interface FlexPersistentVolumeSource { + /** + * Driver is the name of the driver to use for this volume. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Extra command options if any. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#options + */ + readonly options?: { [key: string]: string }; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + +} + +/** + * Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.FlockerVolumeSource + */ +export interface FlockerVolumeSource { + /** + * Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + * + * @schema io.k8s.api.core.v1.FlockerVolumeSource#datasetName + */ + readonly datasetName?: string; + + /** + * UUID of the dataset. This is unique identifier of a Flocker dataset + * + * @schema io.k8s.api.core.v1.FlockerVolumeSource#datasetUUID + */ + readonly datasetUUID?: string; + +} + +/** + * Represents a Persistent Disk resource in Google Compute Engine. + +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. + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource + */ +export interface GcePersistentDiskVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#partition + */ + readonly partition?: number; + + /** + * Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#pdName + */ + readonly pdName: string; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @default false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource + */ +export interface GlusterfsPersistentVolumeSource { + /** + * EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#endpoints + */ + readonly endpoints: string; + + /** + * EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#endpointsNamespace + */ + readonly endpointsNamespace?: string; + + /** + * Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#path + */ + readonly path: string; + + /** + * ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @default false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.HostPathVolumeSource + */ +export interface HostPathVolumeSource { + /** + * Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @schema io.k8s.api.core.v1.HostPathVolumeSource#path + */ + readonly path: string; + + /** + * Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @default More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * @schema io.k8s.api.core.v1.HostPathVolumeSource#type + */ + readonly type?: string; + +} + +/** + * ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource + */ +export interface IscsiPersistentVolumeSource { + /** + * whether support iSCSI Discovery CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#chapAuthDiscovery + */ + readonly chapAuthDiscovery?: boolean; + + /** + * whether support iSCSI Session CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#chapAuthSession + */ + readonly chapAuthSession?: boolean; + + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#initiatorName + */ + readonly initiatorName?: string; + + /** + * Target iSCSI Qualified Name. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#iqn + */ + readonly iqn: string; + + /** + * iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + * + * @default default' (tcp). + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#iscsiInterface + */ + readonly iscsiInterface?: string; + + /** + * iSCSI Target Lun number. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#lun + */ + readonly lun: number; + + /** + * iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#portals + */ + readonly portals?: string[]; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * CHAP Secret for iSCSI target and initiator authentication + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#targetPortal + */ + readonly targetPortal: string; + +} + +/** + * Local represents directly-attached storage with node affinity (Beta feature) + * + * @schema io.k8s.api.core.v1.LocalVolumeSource + */ +export interface LocalVolumeSource { + /** + * Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. + * + * @schema io.k8s.api.core.v1.LocalVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). + * + * @schema io.k8s.api.core.v1.LocalVolumeSource#path + */ + readonly path: string; + +} + +/** + * Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.NFSVolumeSource + */ +export interface NfsVolumeSource { + /** + * Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.NFSVolumeSource#path + */ + readonly path: string; + + /** + * ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @default false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * @schema io.k8s.api.core.v1.NFSVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.NFSVolumeSource#server + */ + readonly server: string; + +} + +/** + * VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. + * + * @schema io.k8s.api.core.v1.VolumeNodeAffinity + */ +export interface VolumeNodeAffinity { + /** + * Required specifies hard node constraints that must be met. + * + * @schema io.k8s.api.core.v1.VolumeNodeAffinity#required + */ + readonly required?: NodeSelector; + +} + +/** + * Represents a Photon Controller persistent disk resource. + * + * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource + */ +export interface PhotonPersistentDiskVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * ID that identifies Photon Controller persistent disk + * + * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource#pdID + */ + readonly pdID: string; + +} + +/** + * PortworxVolumeSource represents a Portworx volume resource. + * + * @schema io.k8s.api.core.v1.PortworxVolumeSource + */ +export interface PortworxVolumeSource { + /** + * FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.PortworxVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.PortworxVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * VolumeID uniquely identifies a Portworx volume + * + * @schema io.k8s.api.core.v1.PortworxVolumeSource#volumeID + */ + readonly volumeID: string; + +} + +/** + * Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource + */ +export interface QuobyteVolumeSource { + /** + * Group to map volume access to Default is no group + * + * @default no group + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#group + */ + readonly group?: string; + + /** + * ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#registry + */ + readonly registry: string; + + /** + * Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#tenant + */ + readonly tenant?: string; + + /** + * User to map volume access to Defaults to serivceaccount user + * + * @default serivceaccount user + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#user + */ + readonly user?: string; + + /** + * Volume is a string that references an already created Quobyte volume by name. + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#volume + */ + readonly volume: string; + +} + +/** + * Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource + */ +export interface RbdPersistentVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#image + */ + readonly image: string; + + /** + * Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#keyring + */ + readonly keyring?: string; + + /** + * A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#pool + */ + readonly pool?: string; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#user + */ + readonly user?: string; + +} + +/** + * ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource + */ +export interface ScaleIoPersistentVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" + * + * @default xfs" + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The host address of the ScaleIO API Gateway. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#gateway + */ + readonly gateway: string; + + /** + * The name of the ScaleIO Protection Domain for the configured storage. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#protectionDomain + */ + readonly protectionDomain?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#secretRef + */ + readonly secretRef: SecretReference; + + /** + * Flag to enable/disable SSL communication with Gateway, default false + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#sslEnabled + */ + readonly sslEnabled?: boolean; + + /** + * Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + * + * @default ThinProvisioned. + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#storageMode + */ + readonly storageMode?: string; + + /** + * The ScaleIO Storage Pool associated with the protection domain. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#storagePool + */ + readonly storagePool?: string; + + /** + * The name of the storage system as configured in ScaleIO. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#system + */ + readonly system: string; + + /** + * The name of a volume already created in the ScaleIO system that is associated with this volume source. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#volumeName + */ + readonly volumeName?: string; + +} + +/** + * Represents a StorageOS persistent volume resource. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource + */ +export interface StorageOsPersistentVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#secretRef + */ + readonly secretRef?: ObjectReference; + + /** + * VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#volumeName + */ + readonly volumeName?: string; + + /** + * VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#volumeNamespace + */ + readonly volumeNamespace?: string; + +} + +/** + * Represents a vSphere volume resource. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource + */ +export interface VsphereVirtualDiskVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#storagePolicyID + */ + readonly storagePolicyID?: string; + + /** + * Storage Policy Based Management (SPBM) profile name. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#storagePolicyName + */ + readonly storagePolicyName?: string; + + /** + * Path that identifies vSphere volume vmdk + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#volumePath + */ + readonly volumePath: string; + +} + +/** + * TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference + */ +export interface TypedLocalObjectReference { + /** + * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind is the type of resource being referenced + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference#name + */ + readonly name: string; + +} + +/** + * ResourceRequirements describes the compute resource requirements. + * + * @schema io.k8s.api.core.v1.ResourceRequirements + */ +export interface ResourceRequirements { + /** + * Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ + * + * @schema io.k8s.api.core.v1.ResourceRequirements#limits + */ + readonly limits?: { [key: string]: Quantity }; + + /** + * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ + * + * @schema io.k8s.api.core.v1.ResourceRequirements#requests + */ + readonly requests?: { [key: string]: Quantity }; + +} + +/** + * Affinity is a group of affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.Affinity + */ +export interface Affinity { + /** + * Describes node affinity scheduling rules for the pod. + * + * @schema io.k8s.api.core.v1.Affinity#nodeAffinity + */ + readonly nodeAffinity?: NodeAffinity; + + /** + * Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + * + * @schema io.k8s.api.core.v1.Affinity#podAffinity + */ + readonly podAffinity?: PodAffinity; + + /** + * Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + * + * @schema io.k8s.api.core.v1.Affinity#podAntiAffinity + */ + readonly podAntiAffinity?: PodAntiAffinity; + +} + +/** + * A single application container that you want to run within a pod. + * + * @schema io.k8s.api.core.v1.Container + */ +export interface Container { + /** + * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.Container#args + */ + readonly args?: string[]; + + /** + * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.Container#command + */ + readonly command?: string[]; + + /** + * List of environment variables to set in the container. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#env + */ + readonly env?: EnvVar[]; + + /** + * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#envFrom + */ + readonly envFrom?: EnvFromSource[]; + + /** + * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + * + * @schema io.k8s.api.core.v1.Container#image + */ + readonly image?: string; + + /** + * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * + * @default Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * @schema io.k8s.api.core.v1.Container#imagePullPolicy + */ + readonly imagePullPolicy?: string; + + /** + * Actions that the management system should take in response to container lifecycle events. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#lifecycle + */ + readonly lifecycle?: Lifecycle; + + /** + * Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Container#livenessProbe + */ + readonly livenessProbe?: Probe; + + /** + * Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#name + */ + readonly name: string; + + /** + * List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#ports + */ + readonly ports?: ContainerPort[]; + + /** + * Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Container#readinessProbe + */ + readonly readinessProbe?: Probe; + + /** + * Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ + * + * @schema io.k8s.api.core.v1.Container#resources + */ + readonly resources?: ResourceRequirements; + + /** + * Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + * + * @schema io.k8s.api.core.v1.Container#securityContext + */ + readonly securityContext?: SecurityContext; + + /** + * StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Container#startupProbe + */ + readonly startupProbe?: Probe; + + /** + * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.Container#stdin + */ + readonly stdin?: boolean; + + /** + * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + * + * @default false + * @schema io.k8s.api.core.v1.Container#stdinOnce + */ + readonly stdinOnce?: boolean; + + /** + * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + * + * @default dev/termination-log. Cannot be updated. + * @schema io.k8s.api.core.v1.Container#terminationMessagePath + */ + readonly terminationMessagePath?: string; + + /** + * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + * + * @default File. Cannot be updated. + * @schema io.k8s.api.core.v1.Container#terminationMessagePolicy + */ + readonly terminationMessagePolicy?: string; + + /** + * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.Container#tty + */ + readonly tty?: boolean; + + /** + * volumeDevices is the list of block devices to be used by the container. This is a beta feature. + * + * @schema io.k8s.api.core.v1.Container#volumeDevices + */ + readonly volumeDevices?: VolumeDevice[]; + + /** + * Pod volumes to mount into the container's filesystem. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#volumeMounts + */ + readonly volumeMounts?: VolumeMount[]; + + /** + * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#workingDir + */ + readonly workingDir?: string; + +} + +/** + * PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + * + * @schema io.k8s.api.core.v1.PodDNSConfig + */ +export interface PodDnsConfig { + /** + * A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. + * + * @schema io.k8s.api.core.v1.PodDNSConfig#nameservers + */ + readonly nameservers?: string[]; + + /** + * A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. + * + * @schema io.k8s.api.core.v1.PodDNSConfig#options + */ + readonly options?: PodDnsConfigOption[]; + + /** + * A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. + * + * @schema io.k8s.api.core.v1.PodDNSConfig#searches + */ + readonly searches?: string[]; + +} + +/** + * An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. + * + * @schema io.k8s.api.core.v1.EphemeralContainer + */ +export interface EphemeralContainer { + /** + * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.EphemeralContainer#args + */ + readonly args?: string[]; + + /** + * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.EphemeralContainer#command + */ + readonly command?: string[]; + + /** + * List of environment variables to set in the container. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#env + */ + readonly env?: EnvVar[]; + + /** + * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#envFrom + */ + readonly envFrom?: EnvFromSource[]; + + /** + * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + * + * @schema io.k8s.api.core.v1.EphemeralContainer#image + */ + readonly image?: string; + + /** + * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * + * @default Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * @schema io.k8s.api.core.v1.EphemeralContainer#imagePullPolicy + */ + readonly imagePullPolicy?: string; + + /** + * Lifecycle is not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#lifecycle + */ + readonly lifecycle?: Lifecycle; + + /** + * Probes are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#livenessProbe + */ + readonly livenessProbe?: Probe; + + /** + * Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#name + */ + readonly name: string; + + /** + * Ports are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#ports + */ + readonly ports?: ContainerPort[]; + + /** + * Probes are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#readinessProbe + */ + readonly readinessProbe?: Probe; + + /** + * Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#resources + */ + readonly resources?: ResourceRequirements; + + /** + * SecurityContext is not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#securityContext + */ + readonly securityContext?: SecurityContext; + + /** + * Probes are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#startupProbe + */ + readonly startupProbe?: Probe; + + /** + * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.EphemeralContainer#stdin + */ + readonly stdin?: boolean; + + /** + * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + * + * @default false + * @schema io.k8s.api.core.v1.EphemeralContainer#stdinOnce + */ + readonly stdinOnce?: boolean; + + /** + * If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#targetContainerName + */ + readonly targetContainerName?: string; + + /** + * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + * + * @default dev/termination-log. Cannot be updated. + * @schema io.k8s.api.core.v1.EphemeralContainer#terminationMessagePath + */ + readonly terminationMessagePath?: string; + + /** + * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + * + * @default File. Cannot be updated. + * @schema io.k8s.api.core.v1.EphemeralContainer#terminationMessagePolicy + */ + readonly terminationMessagePolicy?: string; + + /** + * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.EphemeralContainer#tty + */ + readonly tty?: boolean; + + /** + * volumeDevices is the list of block devices to be used by the container. This is a beta feature. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#volumeDevices + */ + readonly volumeDevices?: VolumeDevice[]; + + /** + * Pod volumes to mount into the container's filesystem. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#volumeMounts + */ + readonly volumeMounts?: VolumeMount[]; + + /** + * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#workingDir + */ + readonly workingDir?: string; + +} + +/** + * HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. + * + * @schema io.k8s.api.core.v1.HostAlias + */ +export interface HostAlias { + /** + * Hostnames for the above IP address. + * + * @schema io.k8s.api.core.v1.HostAlias#hostnames + */ + readonly hostnames?: string[]; + + /** + * IP address of the host file entry. + * + * @schema io.k8s.api.core.v1.HostAlias#ip + */ + readonly ip?: string; + +} + +/** + * PodReadinessGate contains the reference to a pod condition + * + * @schema io.k8s.api.core.v1.PodReadinessGate + */ +export interface PodReadinessGate { + /** + * ConditionType refers to a condition in the pod's condition list with matching type. + * + * @schema io.k8s.api.core.v1.PodReadinessGate#conditionType + */ + readonly conditionType: string; + +} + +/** + * PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. + * + * @schema io.k8s.api.core.v1.PodSecurityContext + */ +export interface PodSecurityContext { + /** + * 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: + +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---- + +If unset, the Kubelet will not modify the ownership and permissions of any volume. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#fsGroup + */ + readonly fsGroup?: number; + + /** + * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#runAsGroup + */ + readonly runAsGroup?: number; + + /** + * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#runAsNonRoot + */ + readonly runAsNonRoot?: boolean; + + /** + * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * + * @default user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * @schema io.k8s.api.core.v1.PodSecurityContext#runAsUser + */ + readonly runAsUser?: number; + + /** + * The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#seLinuxOptions + */ + readonly seLinuxOptions?: SeLinuxOptions; + + /** + * A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#supplementalGroups + */ + readonly supplementalGroups?: number[]; + + /** + * Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#sysctls + */ + readonly sysctls?: Sysctl[]; + + /** + * The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#windowsOptions + */ + readonly windowsOptions?: WindowsSecurityContextOptions; + +} + +/** + * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + * + * @schema io.k8s.api.core.v1.Toleration + */ +export interface Toleration { + /** + * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + * + * @schema io.k8s.api.core.v1.Toleration#effect + */ + readonly effect?: string; + + /** + * Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + * + * @schema io.k8s.api.core.v1.Toleration#key + */ + readonly key?: string; + + /** + * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + * + * @default Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + * @schema io.k8s.api.core.v1.Toleration#operator + */ + readonly operator?: string; + + /** + * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + * + * @schema io.k8s.api.core.v1.Toleration#tolerationSeconds + */ + readonly tolerationSeconds?: number; + + /** + * Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. + * + * @schema io.k8s.api.core.v1.Toleration#value + */ + readonly value?: string; + +} + +/** + * TopologySpreadConstraint specifies how to spread matching pods among the given topology. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint + */ +export interface TopologySpreadConstraint { + /** + * LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#labelSelector + */ + readonly labelSelector?: LabelSelector; + + /** + * MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It's a required field. Default value is 1 and 0 is not allowed. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#maxSkew + */ + readonly maxSkew: number; + + /** + * TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#topologyKey + */ + readonly topologyKey: string; + + /** + * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as "Unsatisfiable" if and only if placing incoming pod on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#whenUnsatisfiable + */ + readonly whenUnsatisfiable: string; + +} + +/** + * Volume represents a named volume in a pod that may be accessed by any container in the pod. + * + * @schema io.k8s.api.core.v1.Volume + */ +export interface Volume { + /** + * AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.Volume#awsElasticBlockStore + */ + readonly awsElasticBlockStore?: AwsElasticBlockStoreVolumeSource; + + /** + * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.Volume#azureDisk + */ + readonly azureDisk?: AzureDiskVolumeSource; + + /** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.Volume#azureFile + */ + readonly azureFile?: AzureFileVolumeSource; + + /** + * CephFS represents a Ceph FS mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.Volume#cephfs + */ + readonly cephfs?: CephFsVolumeSource; + + /** + * Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.Volume#cinder + */ + readonly cinder?: CinderVolumeSource; + + /** + * ConfigMap represents a configMap that should populate this volume + * + * @schema io.k8s.api.core.v1.Volume#configMap + */ + readonly configMap?: ConfigMapVolumeSource; + + /** + * CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). + * + * @schema io.k8s.api.core.v1.Volume#csi + */ + readonly csi?: CsiVolumeSource; + + /** + * DownwardAPI represents downward API about the pod that should populate this volume + * + * @schema io.k8s.api.core.v1.Volume#downwardAPI + */ + readonly downwardAPI?: DownwardApiVolumeSource; + + /** + * EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + * + * @schema io.k8s.api.core.v1.Volume#emptyDir + */ + readonly emptyDir?: EmptyDirVolumeSource; + + /** + * FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + * + * @schema io.k8s.api.core.v1.Volume#fc + */ + readonly fc?: FcVolumeSource; + + /** + * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.Volume#flexVolume + */ + readonly flexVolume?: FlexVolumeSource; + + /** + * Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + * + * @schema io.k8s.api.core.v1.Volume#flocker + */ + readonly flocker?: FlockerVolumeSource; + + /** + * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.Volume#gcePersistentDisk + */ + readonly gcePersistentDisk?: GcePersistentDiskVolumeSource; + + /** + * GitRepo represents a git repository at a particular revision. 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. + * + * @schema io.k8s.api.core.v1.Volume#gitRepo + */ + readonly gitRepo?: GitRepoVolumeSource; + + /** + * Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md + * + * @schema io.k8s.api.core.v1.Volume#glusterfs + */ + readonly glusterfs?: GlusterfsVolumeSource; + + /** + * HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @schema io.k8s.api.core.v1.Volume#hostPath + */ + readonly hostPath?: HostPathVolumeSource; + + /** + * ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md + * + * @schema io.k8s.api.core.v1.Volume#iscsi + */ + readonly iscsi?: IscsiVolumeSource; + + /** + * Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.Volume#name + */ + readonly name: string; + + /** + * NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.Volume#nfs + */ + readonly nfs?: NfsVolumeSource; + + /** + * PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.Volume#persistentVolumeClaim + */ + readonly persistentVolumeClaim?: PersistentVolumeClaimVolumeSource; + + /** + * PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.Volume#photonPersistentDisk + */ + readonly photonPersistentDisk?: PhotonPersistentDiskVolumeSource; + + /** + * PortworxVolume represents a portworx volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.Volume#portworxVolume + */ + readonly portworxVolume?: PortworxVolumeSource; + + /** + * Items for all in one resources secrets, configmaps, and downward API + * + * @schema io.k8s.api.core.v1.Volume#projected + */ + readonly projected?: ProjectedVolumeSource; + + /** + * Quobyte represents a Quobyte mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.Volume#quobyte + */ + readonly quobyte?: QuobyteVolumeSource; + + /** + * RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md + * + * @schema io.k8s.api.core.v1.Volume#rbd + */ + readonly rbd?: RbdVolumeSource; + + /** + * ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + * + * @schema io.k8s.api.core.v1.Volume#scaleIO + */ + readonly scaleIO?: ScaleIoVolumeSource; + + /** + * Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + * + * @schema io.k8s.api.core.v1.Volume#secret + */ + readonly secret?: SecretVolumeSource; + + /** + * StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + * + * @schema io.k8s.api.core.v1.Volume#storageos + */ + readonly storageos?: StorageOsVolumeSource; + + /** + * VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.Volume#vsphereVolume + */ + readonly vsphereVolume?: VsphereVirtualDiskVolumeSource; + +} + +/** + * A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. + * + * @schema io.k8s.api.core.v1.ScopeSelector + */ +export interface ScopeSelector { + /** + * A list of scope selector requirements by scope of the resources. + * + * @schema io.k8s.api.core.v1.ScopeSelector#matchExpressions + */ + readonly matchExpressions?: ScopedResourceSelectorRequirement[]; + +} + +/** + * ServicePort contains information on service's port. + * + * @schema io.k8s.api.core.v1.ServicePort + */ +export interface ServicePort { + /** + * The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. + * + * @schema io.k8s.api.core.v1.ServicePort#name + */ + readonly name?: string; + + /** + * The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + * + * @default to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + * @schema io.k8s.api.core.v1.ServicePort#nodePort + */ + readonly nodePort?: number; + + /** + * The port that will be exposed by this service. + * + * @schema io.k8s.api.core.v1.ServicePort#port + */ + readonly port: number; + + /** + * The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. + * + * @default TCP. + * @schema io.k8s.api.core.v1.ServicePort#protocol + */ + readonly protocol?: string; + + /** + * Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + * + * @schema io.k8s.api.core.v1.ServicePort#targetPort + */ + readonly targetPort?: IntOrString; + +} + +/** + * SessionAffinityConfig represents the configurations of session affinity. + * + * @schema io.k8s.api.core.v1.SessionAffinityConfig + */ +export interface SessionAffinityConfig { + /** + * clientIP contains the configurations of Client IP based session affinity. + * + * @schema io.k8s.api.core.v1.SessionAffinityConfig#clientIP + */ + readonly clientIP?: ClientIpConfig; + +} + +/** + * EndpointConditions represents the current condition of an endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointConditions + */ +export interface EndpointConditions { + /** + * ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointConditions#ready + */ + readonly ready?: boolean; + +} + +/** + * IngressBackend describes all endpoints for a given service and port. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend + */ +export interface IngressBackend { + /** + * Specifies the name of the referenced service. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend#serviceName + */ + readonly serviceName: string; + + /** + * Specifies the port of the referenced service. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend#servicePort + */ + readonly servicePort: IntOrString; + +} + +/** + * IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. + * + * @schema io.k8s.api.networking.v1beta1.IngressRule + */ +export interface IngressRule { + /** + * Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the + IP in the Spec of the parent Ingress. +2. The `:` delimiter is not respected because ports are not allowed. + Currently the port of an Ingress is implicitly :80 for http and + :443 for https. +Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. + * + * @schema io.k8s.api.networking.v1beta1.IngressRule#host + */ + readonly host?: string; + + /** + * @schema io.k8s.api.networking.v1beta1.IngressRule#http + */ + readonly http?: HttpIngressRuleValue; + +} + +/** + * IngressTLS describes the transport layer security associated with an Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressTLS + */ +export interface IngressTls { + /** + * Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + * + * @default the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + * @schema io.k8s.api.networking.v1beta1.IngressTLS#hosts + */ + readonly hosts?: string[]; + + /** + * SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. + * + * @schema io.k8s.api.networking.v1beta1.IngressTLS#secretName + */ + readonly secretName?: string; + +} + +/** + * NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 + * + * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule + */ +export interface NetworkPolicyEgressRule { + /** + * List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule#ports + */ + readonly ports?: NetworkPolicyPort[]; + + /** + * List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule#to + */ + readonly to?: NetworkPolicyPeer[]; + +} + +/** + * NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule + */ +export interface NetworkPolicyIngressRule { + /** + * List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule#from + */ + readonly from?: NetworkPolicyPeer[]; + + /** + * List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule#ports + */ + readonly ports?: NetworkPolicyPort[]; + +} + +/** + * AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used. + * + * @schema io.k8s.api.policy.v1beta1.AllowedCSIDriver + */ +export interface AllowedCsiDriver { + /** + * Name is the registered name of the CSI driver + * + * @schema io.k8s.api.policy.v1beta1.AllowedCSIDriver#name + */ + readonly name: string; + +} + +/** + * AllowedFlexVolume represents a single Flexvolume that is allowed to be used. + * + * @schema io.k8s.api.policy.v1beta1.AllowedFlexVolume + */ +export interface AllowedFlexVolume { + /** + * driver is the name of the Flexvolume driver. + * + * @schema io.k8s.api.policy.v1beta1.AllowedFlexVolume#driver + */ + readonly driver: string; + +} + +/** + * AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. + * + * @schema io.k8s.api.policy.v1beta1.AllowedHostPath + */ +export interface AllowedHostPath { + /** + * pathPrefix is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. + +Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo` + * + * @schema io.k8s.api.policy.v1beta1.AllowedHostPath#pathPrefix + */ + readonly pathPrefix?: string; + + /** + * when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. + * + * @schema io.k8s.api.policy.v1beta1.AllowedHostPath#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * FSGroupStrategyOptions defines the strategy type and options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions + */ +export interface FsGroupStrategyOptions { + /** + * ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions#ranges + */ + readonly ranges?: IdRange[]; + + /** + * rule is the strategy that will dictate what FSGroup is used in the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions#rule + */ + readonly rule?: string; + +} + +/** + * HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. + * + * @schema io.k8s.api.policy.v1beta1.HostPortRange + */ +export interface HostPortRange { + /** + * max is the end of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.HostPortRange#max + */ + readonly max: number; + + /** + * min is the start of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.HostPortRange#min + */ + readonly min: number; + +} + +/** + * RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions + */ +export interface RunAsGroupStrategyOptions { + /** + * ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions#ranges + */ + readonly ranges?: IdRange[]; + + /** + * rule is the strategy that will dictate the allowable RunAsGroup values that may be set. + * + * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions#rule + */ + readonly rule: string; + +} + +/** + * RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions + */ +export interface RunAsUserStrategyOptions { + /** + * ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions#ranges + */ + readonly ranges?: IdRange[]; + + /** + * rule is the strategy that will dictate the allowable RunAsUser values that may be set. + * + * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions#rule + */ + readonly rule: string; + +} + +/** + * RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod. + * + * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions + */ +export interface RuntimeClassStrategyOptions { + /** + * allowedRuntimeClassNames is a whitelist of RuntimeClass names that may be specified on a pod. A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset. + * + * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions#allowedRuntimeClassNames + */ + readonly allowedRuntimeClassNames: string[]; + + /** + * defaultRuntimeClassName is the default RuntimeClassName to set on the pod. The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod. + * + * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions#defaultRuntimeClassName + */ + readonly defaultRuntimeClassName?: string; + +} + +/** + * SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions + */ +export interface SeLinuxStrategyOptions { + /** + * rule is the strategy that will dictate the allowable labels that may be set. + * + * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions#rule + */ + readonly rule: string; + + /** + * seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + * + * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions#seLinuxOptions + */ + readonly seLinuxOptions?: SeLinuxOptions; + +} + +/** + * SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions + */ +export interface SupplementalGroupsStrategyOptions { + /** + * ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions#ranges + */ + readonly ranges?: IdRange[]; + + /** + * rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions#rule + */ + readonly rule?: string; + +} + +/** + * FlowDistinguisherMethod specifies the method of a flow distinguisher. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowDistinguisherMethod + */ +export interface FlowDistinguisherMethod { + /** + * `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.FlowDistinguisherMethod#type + */ + readonly type: string; + +} + +/** + * PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationReference + */ +export interface PriorityLevelConfigurationReference { + /** + * `name` is the name of the priority level configuration being referenced Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationReference#name + */ + readonly name: string; + +} + +/** + * PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects + */ +export interface PolicyRulesWithSubjects { + /** + * `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects#nonResourceRules + */ + readonly nonResourceRules?: NonResourcePolicyRule[]; + + /** + * `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects#resourceRules + */ + readonly resourceRules?: ResourcePolicyRule[]; + + /** + * subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects#subjects + */ + readonly subjects: Subject[]; + +} + +/** + * LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: + * How are requests for this priority level limited? + * What should be done with requests that exceed the limit? + * + * @schema io.k8s.api.flowcontrol.v1alpha1.LimitedPriorityLevelConfiguration + */ +export interface LimitedPriorityLevelConfiguration { + /** + * `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: + + ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) + +bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.LimitedPriorityLevelConfiguration#assuredConcurrencyShares + */ + readonly assuredConcurrencyShares?: number; + + /** + * `limitResponse` indicates what to do with requests that can not be executed right now + * + * @schema io.k8s.api.flowcontrol.v1alpha1.LimitedPriorityLevelConfiguration#limitResponse + */ + readonly limitResponse?: LimitResponse; + +} + +/** + * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind + */ +export enum IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind { + /** DeleteOptions */ + DELETE_OPTIONS = "DeleteOptions", +} + +/** + * Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions + */ +export interface Preconditions { + /** + * Specifies the target ResourceVersion + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * Specifies the target UID. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions#uid + */ + readonly uid?: string; + +} + +/** + * @schema io.k8s.apimachinery.pkg.util.intstr.IntOrString + */ +export class IntOrString { + public static fromString(value: string): IntOrString { + return new IntOrString(value); + } + public static fromNumber(value: number): IntOrString { + return new IntOrString(value); + } + private constructor(value: any) { + Object.defineProperty(this, 'resolve', { value: () => value }); + } +} + +/** + * EnvVar represents an environment variable present in a Container. + * + * @schema io.k8s.api.core.v1.EnvVar + */ +export interface EnvVar { + /** + * Name of the environment variable. Must be a C_IDENTIFIER. + * + * @schema io.k8s.api.core.v1.EnvVar#name + */ + readonly name: string; + + /** + * Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + * + * @default . + * @schema io.k8s.api.core.v1.EnvVar#value + */ + readonly value?: string; + + /** + * Source for the environment variable's value. Cannot be used if value is not empty. + * + * @schema io.k8s.api.core.v1.EnvVar#valueFrom + */ + readonly valueFrom?: EnvVarSource; + +} + +/** + * EnvFromSource represents the source of a set of ConfigMaps + * + * @schema io.k8s.api.core.v1.EnvFromSource + */ +export interface EnvFromSource { + /** + * The ConfigMap to select from + * + * @schema io.k8s.api.core.v1.EnvFromSource#configMapRef + */ + readonly configMapRef?: ConfigMapEnvSource; + + /** + * An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + * + * @schema io.k8s.api.core.v1.EnvFromSource#prefix + */ + readonly prefix?: string; + + /** + * The Secret to select from + * + * @schema io.k8s.api.core.v1.EnvFromSource#secretRef + */ + readonly secretRef?: SecretEnvSource; + +} + +/** + * VolumeMount describes a mounting of a Volume within a container. + * + * @schema io.k8s.api.core.v1.VolumeMount + */ +export interface VolumeMount { + /** + * Path within the container at which the volume should be mounted. Must not contain ':'. + * + * @schema io.k8s.api.core.v1.VolumeMount#mountPath + */ + readonly mountPath: string; + + /** + * mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + * + * @schema io.k8s.api.core.v1.VolumeMount#mountPropagation + */ + readonly mountPropagation?: string; + + /** + * This must match the Name of a Volume. + * + * @schema io.k8s.api.core.v1.VolumeMount#name + */ + readonly name: string; + + /** + * Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.VolumeMount#readOnly + */ + readonly readOnly?: boolean; + + /** + * Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + * + * @default volume's root). + * @schema io.k8s.api.core.v1.VolumeMount#subPath + */ + readonly subPath?: string; + + /** + * Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + * + * @default volume's root). SubPathExpr and SubPath are mutually exclusive. + * @schema io.k8s.api.core.v1.VolumeMount#subPathExpr + */ + readonly subPathExpr?: string; + +} + +/** + * CSINodeDriver holds information about the specification of one CSI driver installed on a node + * + * @schema io.k8s.api.storage.v1.CSINodeDriver + */ +export interface CsiNodeDriver { + /** + * allocatable represents the volume resources of a node that are available for scheduling. This field is beta. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#allocatable + */ + readonly allocatable?: VolumeNodeResources; + + /** + * This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#name + */ + readonly name: string; + + /** + * nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#nodeID + */ + readonly nodeID: string; + + /** + * topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#topologyKeys + */ + readonly topologyKeys?: string[]; + +} + +/** + * A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future. + * + * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement + */ +export interface TopologySelectorLabelRequirement { + /** + * The label key that the selector applies to. + * + * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement#key + */ + readonly key: string; + + /** + * An array of string values. One value must match the label to be selected. Each entry in Values is ORed. + * + * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement#values + */ + readonly values: string[]; + +} + +/** + * VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSource + */ +export interface VolumeAttachmentSource { + /** + * inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSource#inlineVolumeSpec + */ + readonly inlineVolumeSpec?: PersistentVolumeSpec; + + /** + * Name of the persistent volume to attach. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSource#persistentVolumeName + */ + readonly persistentVolumeName?: string; + +} + +/** + * CustomResourceConversion describes how to convert different versions of a CR. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion + */ +export interface CustomResourceConversion { + /** + * strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information + is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion#strategy + */ + readonly strategy: string; + + /** + * webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion#webhook + */ + readonly webhook?: WebhookConversion; + +} + +/** + * CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames + */ +export interface CustomResourceDefinitionNames { + /** + * categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#categories + */ + readonly categories?: string[]; + + /** + * kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#kind + */ + readonly kind: string; + + /** + * listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". + * + * @default kind`List". + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#listKind + */ + readonly listKind?: string; + + /** + * plural is the plural name of the resource to serve. The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#plural + */ + readonly plural: string; + + /** + * shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. It must be all lowercase. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#shortNames + */ + readonly shortNames?: string[]; + + /** + * singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. + * + * @default lowercased `kind`. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#singular + */ + readonly singular?: string; + +} + +/** + * CustomResourceDefinitionVersion describes a version for CRD. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion + */ +export interface CustomResourceDefinitionVersion { + /** + * additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#additionalPrinterColumns + */ + readonly additionalPrinterColumns?: CustomResourceColumnDefinition[]; + + /** + * name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#name + */ + readonly name: string; + + /** + * schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#schema + */ + readonly schema?: CustomResourceValidation; + + /** + * served is a flag enabling/disabling this version from being served via REST APIs + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#served + */ + readonly served: boolean; + + /** + * storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#storage + */ + readonly storage: boolean; + + /** + * subresources specify what subresources this version of the defined custom resource have. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#subresources + */ + readonly subresources?: CustomResourceSubresources; + +} + +/** + * StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause + */ +export interface StatusCause { + /** + * The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. + +Examples: + "name" - the field "name" on the current resource + "items[0].name" - the field "name" on the first array entry in "items" + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#field + */ + readonly field?: string; + + /** + * A human-readable description of the cause of the error. This field may be presented as-is to a reader. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#message + */ + readonly message?: string; + + /** + * A machine-readable description of the cause of the error. If this value is empty there is no information available. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#reason + */ + readonly reason?: string; + +} + +/** + * ServiceReference holds a reference to Service.legacy.k8s.io + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference + */ +export interface ServiceReference { + /** + * `name` is the name of the service. Required + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#name + */ + readonly name: string; + + /** + * `namespace` is the namespace of the service. Required + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#namespace + */ + readonly namespace: string; + + /** + * `path` is an optional URL path which will be sent in any request to this service. + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#path + */ + readonly path?: string; + + /** + * If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + * + * @default 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#port + */ + readonly port?: number; + +} + +/** + * A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement + */ +export interface LabelSelectorRequirement { + /** + * key is the label key that the selector applies to. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#key + */ + readonly key: string; + + /** + * operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#operator + */ + readonly operator: string; + + /** + * values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#values + */ + readonly values?: string[]; + +} + +/** + * Spec to control the desired behavior of daemon set rolling update. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet + */ +export interface RollingUpdateDaemonSet { + /** + * The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + +} + +/** + * Spec to control the desired behavior of rolling update. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDeployment + */ +export interface RollingUpdateDeployment { + /** + * The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. + * + * @default 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. + * @schema io.k8s.api.apps.v1.RollingUpdateDeployment#maxSurge + */ + readonly maxSurge?: IntOrString; + + /** + * The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. + * + * @default 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. + * @schema io.k8s.api.apps.v1.RollingUpdateDeployment#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + +} + +/** + * RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. + * + * @schema io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy + */ +export interface RollingUpdateStatefulSetStrategy { + /** + * Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. + * + * @schema io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy#partition + */ + readonly partition?: number; + +} + +/** + * WebhookThrottleConfig holds the configuration for throttling events + * + * @schema io.k8s.api.auditregistration.v1alpha1.WebhookThrottleConfig + */ +export interface WebhookThrottleConfig { + /** + * ThrottleBurst is the maximum number of events sent at the same moment default 15 QPS + * + * @schema io.k8s.api.auditregistration.v1alpha1.WebhookThrottleConfig#burst + */ + readonly burst?: number; + + /** + * ThrottleQPS maximum number of batches per second default 10 QPS + * + * @schema io.k8s.api.auditregistration.v1alpha1.WebhookThrottleConfig#qps + */ + readonly qps?: number; + +} + +/** + * ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource + */ +export interface ConfigMapNodeConfigSource { + /** + * KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#kubeletConfigKey + */ + readonly kubeletConfigKey: string; + + /** + * Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#name + */ + readonly name: string; + + /** + * Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#namespace + */ + readonly namespace: string; + + /** + * ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#uid + */ + readonly uid?: string; + +} + +/** + * SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + * + * @schema io.k8s.api.core.v1.SecretReference + */ +export interface SecretReference { + /** + * Name is unique within a namespace to reference a secret resource. + * + * @schema io.k8s.api.core.v1.SecretReference#name + */ + readonly name?: string; + + /** + * Namespace defines the space within which the secret name must be unique. + * + * @schema io.k8s.api.core.v1.SecretReference#namespace + */ + readonly namespace?: string; + +} + +/** + * A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. + * + * @schema io.k8s.api.core.v1.NodeSelector + */ +export interface NodeSelector { + /** + * Required. A list of node selector terms. The terms are ORed. + * + * @schema io.k8s.api.core.v1.NodeSelector#nodeSelectorTerms + */ + readonly nodeSelectorTerms: NodeSelectorTerm[]; + +} + +/** + * Node affinity is a group of node affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.NodeAffinity + */ +export interface NodeAffinity { + /** + * The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. + * + * @schema io.k8s.api.core.v1.NodeAffinity#preferredDuringSchedulingIgnoredDuringExecution + */ + readonly preferredDuringSchedulingIgnoredDuringExecution?: PreferredSchedulingTerm[]; + + /** + * If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. + * + * @schema io.k8s.api.core.v1.NodeAffinity#requiredDuringSchedulingIgnoredDuringExecution + */ + readonly requiredDuringSchedulingIgnoredDuringExecution?: NodeSelector; + +} + +/** + * Pod affinity is a group of inter pod affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.PodAffinity + */ +export interface PodAffinity { + /** + * The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + * + * @schema io.k8s.api.core.v1.PodAffinity#preferredDuringSchedulingIgnoredDuringExecution + */ + readonly preferredDuringSchedulingIgnoredDuringExecution?: WeightedPodAffinityTerm[]; + + /** + * If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + * + * @schema io.k8s.api.core.v1.PodAffinity#requiredDuringSchedulingIgnoredDuringExecution + */ + readonly requiredDuringSchedulingIgnoredDuringExecution?: PodAffinityTerm[]; + +} + +/** + * Pod anti affinity is a group of inter pod anti affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.PodAntiAffinity + */ +export interface PodAntiAffinity { + /** + * The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + * + * @schema io.k8s.api.core.v1.PodAntiAffinity#preferredDuringSchedulingIgnoredDuringExecution + */ + readonly preferredDuringSchedulingIgnoredDuringExecution?: WeightedPodAffinityTerm[]; + + /** + * If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + * + * @schema io.k8s.api.core.v1.PodAntiAffinity#requiredDuringSchedulingIgnoredDuringExecution + */ + readonly requiredDuringSchedulingIgnoredDuringExecution?: PodAffinityTerm[]; + +} + +/** + * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + * + * @schema io.k8s.api.core.v1.Lifecycle + */ +export interface Lifecycle { + /** + * PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + * + * @schema io.k8s.api.core.v1.Lifecycle#postStart + */ + readonly postStart?: Handler; + + /** + * PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + * + * @schema io.k8s.api.core.v1.Lifecycle#preStop + */ + readonly preStop?: Handler; + +} + +/** + * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + * + * @schema io.k8s.api.core.v1.Probe + */ +export interface Probe { + /** + * One and only one of the following should be specified. Exec specifies the action to take. + * + * @schema io.k8s.api.core.v1.Probe#exec + */ + readonly exec?: ExecAction; + + /** + * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + * + * @default 3. Minimum value is 1. + * @schema io.k8s.api.core.v1.Probe#failureThreshold + */ + readonly failureThreshold?: number; + + /** + * HTTPGet specifies the http request to perform. + * + * @schema io.k8s.api.core.v1.Probe#httpGet + */ + readonly httpGet?: HttpGetAction; + + /** + * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Probe#initialDelaySeconds + */ + readonly initialDelaySeconds?: number; + + /** + * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + * + * @default 10 seconds. Minimum value is 1. + * @schema io.k8s.api.core.v1.Probe#periodSeconds + */ + readonly periodSeconds?: number; + + /** + * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + * + * @default 1. Must be 1 for liveness and startup. Minimum value is 1. + * @schema io.k8s.api.core.v1.Probe#successThreshold + */ + readonly successThreshold?: number; + + /** + * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported + * + * @schema io.k8s.api.core.v1.Probe#tcpSocket + */ + readonly tcpSocket?: TcpSocketAction; + + /** + * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @default 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * @schema io.k8s.api.core.v1.Probe#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * ContainerPort represents a network port in a single container. + * + * @schema io.k8s.api.core.v1.ContainerPort + */ +export interface ContainerPort { + /** + * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + * + * @schema io.k8s.api.core.v1.ContainerPort#containerPort + */ + readonly containerPort: number; + + /** + * What host IP to bind the external port to. + * + * @schema io.k8s.api.core.v1.ContainerPort#hostIP + */ + readonly hostIP?: string; + + /** + * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + * + * @schema io.k8s.api.core.v1.ContainerPort#hostPort + */ + readonly hostPort?: number; + + /** + * If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + * + * @schema io.k8s.api.core.v1.ContainerPort#name + */ + readonly name?: string; + + /** + * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + * + * @default TCP". + * @schema io.k8s.api.core.v1.ContainerPort#protocol + */ + readonly protocol?: string; + +} + +/** + * SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext + */ +export interface SecurityContext { + /** + * AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + * + * @schema io.k8s.api.core.v1.SecurityContext#allowPrivilegeEscalation + */ + readonly allowPrivilegeEscalation?: boolean; + + /** + * The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. + * + * @default the default set of capabilities granted by the container runtime. + * @schema io.k8s.api.core.v1.SecurityContext#capabilities + */ + readonly capabilities?: Capabilities; + + /** + * Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.SecurityContext#privileged + */ + readonly privileged?: boolean; + + /** + * procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + * + * @schema io.k8s.api.core.v1.SecurityContext#procMount + */ + readonly procMount?: string; + + /** + * Whether this container has a read-only root filesystem. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.SecurityContext#readOnlyRootFilesystem + */ + readonly readOnlyRootFilesystem?: boolean; + + /** + * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#runAsGroup + */ + readonly runAsGroup?: number; + + /** + * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#runAsNonRoot + */ + readonly runAsNonRoot?: boolean; + + /** + * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @default user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * @schema io.k8s.api.core.v1.SecurityContext#runAsUser + */ + readonly runAsUser?: number; + + /** + * The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#seLinuxOptions + */ + readonly seLinuxOptions?: SeLinuxOptions; + + /** + * The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#windowsOptions + */ + readonly windowsOptions?: WindowsSecurityContextOptions; + +} + +/** + * volumeDevice describes a mapping of a raw block device within a container. + * + * @schema io.k8s.api.core.v1.VolumeDevice + */ +export interface VolumeDevice { + /** + * devicePath is the path inside of the container that the device will be mapped to. + * + * @schema io.k8s.api.core.v1.VolumeDevice#devicePath + */ + readonly devicePath: string; + + /** + * name must match the name of a persistentVolumeClaim in the pod + * + * @schema io.k8s.api.core.v1.VolumeDevice#name + */ + readonly name: string; + +} + +/** + * PodDNSConfigOption defines DNS resolver options of a pod. + * + * @schema io.k8s.api.core.v1.PodDNSConfigOption + */ +export interface PodDnsConfigOption { + /** + * Required. + * + * @schema io.k8s.api.core.v1.PodDNSConfigOption#name + */ + readonly name?: string; + + /** + * @schema io.k8s.api.core.v1.PodDNSConfigOption#value + */ + readonly value?: string; + +} + +/** + * SELinuxOptions are the labels to be applied to the container + * + * @schema io.k8s.api.core.v1.SELinuxOptions + */ +export interface SeLinuxOptions { + /** + * Level is SELinux level label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#level + */ + readonly level?: string; + + /** + * Role is a SELinux role label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#role + */ + readonly role?: string; + + /** + * Type is a SELinux type label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#type + */ + readonly type?: string; + + /** + * User is a SELinux user label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#user + */ + readonly user?: string; + +} + +/** + * Sysctl defines a kernel parameter to be set + * + * @schema io.k8s.api.core.v1.Sysctl + */ +export interface Sysctl { + /** + * Name of a property to set + * + * @schema io.k8s.api.core.v1.Sysctl#name + */ + readonly name: string; + + /** + * Value of a property to set + * + * @schema io.k8s.api.core.v1.Sysctl#value + */ + readonly value: string; + +} + +/** + * WindowsSecurityContextOptions contain Windows-specific options and credentials. + * + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions + */ +export interface WindowsSecurityContextOptions { + /** + * GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. + * + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#gmsaCredentialSpec + */ + readonly gmsaCredentialSpec?: string; + + /** + * GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. + * + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#gmsaCredentialSpecName + */ + readonly gmsaCredentialSpecName?: string; + + /** + * The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. + * + * @default the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#runAsUserName + */ + readonly runAsUserName?: string; + +} + +/** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.AzureFileVolumeSource + */ +export interface AzureFileVolumeSource { + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.AzureFileVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * the name of secret that contains Azure Storage Account Name and Key + * + * @schema io.k8s.api.core.v1.AzureFileVolumeSource#secretName + */ + readonly secretName: string; + + /** + * Share Name + * + * @schema io.k8s.api.core.v1.AzureFileVolumeSource#shareName + */ + readonly shareName: string; + +} + +/** + * Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource + */ +export interface CephFsVolumeSource { + /** + * Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * Optional: Used as the mounted root, rather than the full Ceph tree, default is / + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#path + */ + readonly path?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.CephFSVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#secretFile + */ + readonly secretFile?: string; + + /** + * Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#user + */ + readonly user?: string; + +} + +/** + * Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CinderVolumeSource + */ +export interface CinderVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * @schema io.k8s.api.core.v1.CinderVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: points to a secret object containing parameters used to connect to OpenStack. + * + * @schema io.k8s.api.core.v1.CinderVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderVolumeSource#volumeID + */ + readonly volumeID: string; + +} + +/** + * Adapts a ConfigMap into a volume. + +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. + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource + */ +export interface ConfigMapVolumeSource { + /** + * Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#items + */ + readonly items?: KeyToPath[]; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap or its keys must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#optional + */ + readonly optional?: boolean; + +} + +/** + * Represents a source location of a volume to mount, managed by an external CSI driver + * + * @schema io.k8s.api.core.v1.CSIVolumeSource + */ +export interface CsiVolumeSource { + /** + * Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#nodePublishSecretRef + */ + readonly nodePublishSecretRef?: LocalObjectReference; + + /** + * Specifies a read-only configuration for the volume. Defaults to false (read/write). + * + * @default false (read/write). + * @schema io.k8s.api.core.v1.CSIVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#volumeAttributes + */ + readonly volumeAttributes?: { [key: string]: string }; + +} + +/** + * DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource + */ +export interface DownwardApiVolumeSource { + /** + * Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * Items is a list of downward API volume file + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource#items + */ + readonly items?: DownwardApiVolumeFile[]; + +} + +/** + * Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.EmptyDirVolumeSource + */ +export interface EmptyDirVolumeSource { + /** + * What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + * + * @schema io.k8s.api.core.v1.EmptyDirVolumeSource#medium + */ + readonly medium?: string; + + /** + * Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir + * + * @schema io.k8s.api.core.v1.EmptyDirVolumeSource#sizeLimit + */ + readonly sizeLimit?: Quantity; + +} + +/** + * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource + */ +export interface FlexVolumeSource { + /** + * Driver is the name of the driver to use for this volume. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Extra command options if any. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#options + */ + readonly options?: { [key: string]: string }; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.FlexVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + +} + +/** + * 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. + +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. + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource + */ +export interface GitRepoVolumeSource { + /** + * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource#directory + */ + readonly directory?: string; + + /** + * Repository URL + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource#repository + */ + readonly repository: string; + + /** + * Commit hash for the specified revision. + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource#revision + */ + readonly revision?: string; + +} + +/** + * Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource + */ +export interface GlusterfsVolumeSource { + /** + * EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#endpoints + */ + readonly endpoints: string; + + /** + * Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#path + */ + readonly path: string; + + /** + * ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @default false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource + */ +export interface IscsiVolumeSource { + /** + * whether support iSCSI Discovery CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#chapAuthDiscovery + */ + readonly chapAuthDiscovery?: boolean; + + /** + * whether support iSCSI Session CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#chapAuthSession + */ + readonly chapAuthSession?: boolean; + + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#initiatorName + */ + readonly initiatorName?: string; + + /** + * Target iSCSI Qualified Name. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#iqn + */ + readonly iqn: string; + + /** + * iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + * + * @default default' (tcp). + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#iscsiInterface + */ + readonly iscsiInterface?: string; + + /** + * iSCSI Target Lun number. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#lun + */ + readonly lun: number; + + /** + * iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#portals + */ + readonly portals?: string[]; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * CHAP Secret for iSCSI target and initiator authentication + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#targetPortal + */ + readonly targetPortal: string; + +} + +/** + * PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource + */ +export interface PersistentVolumeClaimVolumeSource { + /** + * ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource#claimName + */ + readonly claimName: string; + + /** + * Will force the ReadOnly setting in VolumeMounts. Default false. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Represents a projected volume source + * + * @schema io.k8s.api.core.v1.ProjectedVolumeSource + */ +export interface ProjectedVolumeSource { + /** + * Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @schema io.k8s.api.core.v1.ProjectedVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * list of volume projections + * + * @schema io.k8s.api.core.v1.ProjectedVolumeSource#sources + */ + readonly sources: VolumeProjection[]; + +} + +/** + * Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.RBDVolumeSource + */ +export interface RbdVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + * + * @schema io.k8s.api.core.v1.RBDVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDVolumeSource#image + */ + readonly image: string; + + /** + * Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#keyring + */ + readonly keyring?: string; + + /** + * A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#pool + */ + readonly pool?: string; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#user + */ + readonly user?: string; + +} + +/** + * ScaleIOVolumeSource represents a persistent ScaleIO volume + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource + */ +export interface ScaleIoVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + * + * @default xfs". + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The host address of the ScaleIO API Gateway. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#gateway + */ + readonly gateway: string; + + /** + * The name of the ScaleIO Protection Domain for the configured storage. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#protectionDomain + */ + readonly protectionDomain?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#secretRef + */ + readonly secretRef: LocalObjectReference; + + /** + * Flag to enable/disable SSL communication with Gateway, default false + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#sslEnabled + */ + readonly sslEnabled?: boolean; + + /** + * Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + * + * @default ThinProvisioned. + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#storageMode + */ + readonly storageMode?: string; + + /** + * The ScaleIO Storage Pool associated with the protection domain. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#storagePool + */ + readonly storagePool?: string; + + /** + * The name of the storage system as configured in ScaleIO. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#system + */ + readonly system: string; + + /** + * The name of a volume already created in the ScaleIO system that is associated with this volume source. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#volumeName + */ + readonly volumeName?: string; + +} + +/** + * Adapts a Secret into a volume. + +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. + * + * @schema io.k8s.api.core.v1.SecretVolumeSource + */ +export interface SecretVolumeSource { + /** + * Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * @schema io.k8s.api.core.v1.SecretVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.SecretVolumeSource#items + */ + readonly items?: KeyToPath[]; + + /** + * Specify whether the Secret or its keys must be defined + * + * @schema io.k8s.api.core.v1.SecretVolumeSource#optional + */ + readonly optional?: boolean; + + /** + * Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + * + * @schema io.k8s.api.core.v1.SecretVolumeSource#secretName + */ + readonly secretName?: string; + +} + +/** + * Represents a StorageOS persistent volume resource. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource + */ +export interface StorageOsVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#volumeName + */ + readonly volumeName?: string; + + /** + * VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#volumeNamespace + */ + readonly volumeNamespace?: string; + +} + +/** + * A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement + */ +export interface ScopedResourceSelectorRequirement { + /** + * Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#operator + */ + readonly operator: string; + + /** + * The name of the scope that the selector applies to. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#scopeName + */ + readonly scopeName: string; + + /** + * An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#values + */ + readonly values?: string[]; + +} + +/** + * ClientIPConfig represents the configurations of Client IP based session affinity. + * + * @schema io.k8s.api.core.v1.ClientIPConfig + */ +export interface ClientIpConfig { + /** + * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). + * + * @schema io.k8s.api.core.v1.ClientIPConfig#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressRuleValue + */ +export interface HttpIngressRuleValue { + /** + * A collection of paths that map requests to backends. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressRuleValue#paths + */ + readonly paths: HttpIngressPath[]; + +} + +/** + * NetworkPolicyPort describes a port to allow traffic on + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort + */ +export interface NetworkPolicyPort { + /** + * The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort#port + */ + readonly port?: IntOrString; + + /** + * The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort#protocol + */ + readonly protocol?: string; + +} + +/** + * NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer + */ +export interface NetworkPolicyPeer { + /** + * IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#ipBlock + */ + readonly ipBlock?: IpBlock; + + /** + * Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. + +If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. + +If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#podSelector + */ + readonly podSelector?: LabelSelector; + +} + +/** + * IDRange provides a min/max of an allowed range of IDs. + * + * @schema io.k8s.api.policy.v1beta1.IDRange + */ +export interface IdRange { + /** + * max is the end of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.IDRange#max + */ + readonly max: number; + + /** + * min is the start of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.IDRange#min + */ + readonly min: number; + +} + +/** + * NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.NonResourcePolicyRule + */ +export interface NonResourcePolicyRule { + /** + * `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: + - "/healthz" is legal + - "/hea*" is illegal + - "/hea" is legal but matches nothing + - "/hea/*" also matches nothing + - "/healthz/*" matches all per-component health checks. +"*" matches all non-resource urls. if it is present, it must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.NonResourcePolicyRule#nonResourceURLs + */ + readonly nonResourceURLs: string[]; + + /** + * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.NonResourcePolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule + */ +export interface ResourcePolicyRule { + /** + * `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#apiGroups + */ + readonly apiGroups: string[]; + + /** + * `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#clusterScope + */ + readonly clusterScope?: boolean; + + /** + * `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#namespaces + */ + readonly namespaces?: string[]; + + /** + * `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#resources + */ + readonly resources: string[]; + + /** + * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * LimitResponse defines how to handle requests that can not be executed right now. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.LimitResponse + */ +export interface LimitResponse { + /** + * `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.LimitResponse#queuing + */ + readonly queuing?: QueuingConfiguration; + + /** + * `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.LimitResponse#type + */ + readonly type: string; + +} + +/** + * EnvVarSource represents a source for the value of an EnvVar. + * + * @schema io.k8s.api.core.v1.EnvVarSource + */ +export interface EnvVarSource { + /** + * Selects a key of a ConfigMap. + * + * @schema io.k8s.api.core.v1.EnvVarSource#configMapKeyRef + */ + readonly configMapKeyRef?: ConfigMapKeySelector; + + /** + * Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + * + * @schema io.k8s.api.core.v1.EnvVarSource#fieldRef + */ + readonly fieldRef?: ObjectFieldSelector; + + /** + * Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + * + * @schema io.k8s.api.core.v1.EnvVarSource#resourceFieldRef + */ + readonly resourceFieldRef?: ResourceFieldSelector; + + /** + * Selects a key of a secret in the pod's namespace + * + * @schema io.k8s.api.core.v1.EnvVarSource#secretKeyRef + */ + readonly secretKeyRef?: SecretKeySelector; + +} + +/** + * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + * + * @schema io.k8s.api.core.v1.ConfigMapEnvSource + */ +export interface ConfigMapEnvSource { + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapEnvSource#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapEnvSource#optional + */ + readonly optional?: boolean; + +} + +/** + * SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + * + * @schema io.k8s.api.core.v1.SecretEnvSource + */ +export interface SecretEnvSource { + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.SecretEnvSource#name + */ + readonly name?: string; + + /** + * Specify whether the Secret must be defined + * + * @schema io.k8s.api.core.v1.SecretEnvSource#optional + */ + readonly optional?: boolean; + +} + +/** + * VolumeNodeResources is a set of resource limits for scheduling of volumes. + * + * @schema io.k8s.api.storage.v1.VolumeNodeResources + */ +export interface VolumeNodeResources { + /** + * Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded. + * + * @schema io.k8s.api.storage.v1.VolumeNodeResources#count + */ + readonly count?: number; + +} + +/** + * WebhookConversion describes how to call a conversion webhook + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion + */ +export interface WebhookConversion { + /** + * clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion#clientConfig + */ + readonly clientConfig?: WebhookClientConfig; + + /** + * conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion#conversionReviewVersions + */ + readonly conversionReviewVersions: string[]; + +} + +/** + * CustomResourceColumnDefinition specifies a column for server side printing. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition + */ +export interface CustomResourceColumnDefinition { + /** + * description is a human readable description of this column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#description + */ + readonly description?: string; + + /** + * format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#format + */ + readonly format?: string; + + /** + * jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#jsonPath + */ + readonly jsonPath: string; + + /** + * name is a human readable name for the column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#name + */ + readonly name: string; + + /** + * priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#priority + */ + readonly priority?: number; + + /** + * type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#type + */ + readonly type: string; + +} + +/** + * CustomResourceValidation is a list of validation methods for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation + */ +export interface CustomResourceValidation { + /** + * openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation#openAPIV3Schema + */ + readonly openAPIV3Schema?: JsonSchemaProps; + +} + +/** + * CustomResourceSubresources defines the status and scale subresources for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources + */ +export interface CustomResourceSubresources { + /** + * scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources#scale + */ + readonly scale?: CustomResourceSubresourceScale; + + /** + * status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources#status + */ + readonly status?: any; + +} + +/** + * A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + * + * @schema io.k8s.api.core.v1.NodeSelectorTerm + */ +export interface NodeSelectorTerm { + /** + * A list of node selector requirements by node's labels. + * + * @schema io.k8s.api.core.v1.NodeSelectorTerm#matchExpressions + */ + readonly matchExpressions?: NodeSelectorRequirement[]; + + /** + * A list of node selector requirements by node's fields. + * + * @schema io.k8s.api.core.v1.NodeSelectorTerm#matchFields + */ + readonly matchFields?: NodeSelectorRequirement[]; + +} + +/** + * An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + * + * @schema io.k8s.api.core.v1.PreferredSchedulingTerm + */ +export interface PreferredSchedulingTerm { + /** + * A node selector term, associated with the corresponding weight. + * + * @schema io.k8s.api.core.v1.PreferredSchedulingTerm#preference + */ + readonly preference: NodeSelectorTerm; + + /** + * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + * + * @schema io.k8s.api.core.v1.PreferredSchedulingTerm#weight + */ + readonly weight: number; + +} + +/** + * The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + * + * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm + */ +export interface WeightedPodAffinityTerm { + /** + * Required. A pod affinity term, associated with the corresponding weight. + * + * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm#podAffinityTerm + */ + readonly podAffinityTerm: PodAffinityTerm; + + /** + * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + * + * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm#weight + */ + readonly weight: number; + +} + +/** + * Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + * + * @schema io.k8s.api.core.v1.PodAffinityTerm + */ +export interface PodAffinityTerm { + /** + * A label query over a set of resources, in this case pods. + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#labelSelector + */ + readonly labelSelector?: LabelSelector; + + /** + * namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#namespaces + */ + readonly namespaces?: string[]; + + /** + * This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#topologyKey + */ + readonly topologyKey: string; + +} + +/** + * Handler defines a specific action that should be taken + * + * @schema io.k8s.api.core.v1.Handler + */ +export interface Handler { + /** + * One and only one of the following should be specified. Exec specifies the action to take. + * + * @schema io.k8s.api.core.v1.Handler#exec + */ + readonly exec?: ExecAction; + + /** + * HTTPGet specifies the http request to perform. + * + * @schema io.k8s.api.core.v1.Handler#httpGet + */ + readonly httpGet?: HttpGetAction; + + /** + * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported + * + * @schema io.k8s.api.core.v1.Handler#tcpSocket + */ + readonly tcpSocket?: TcpSocketAction; + +} + +/** + * ExecAction describes a "run in container" action. + * + * @schema io.k8s.api.core.v1.ExecAction + */ +export interface ExecAction { + /** + * Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + * + * @schema io.k8s.api.core.v1.ExecAction#command + */ + readonly command?: string[]; + +} + +/** + * HTTPGetAction describes an action based on HTTP Get requests. + * + * @schema io.k8s.api.core.v1.HTTPGetAction + */ +export interface HttpGetAction { + /** + * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#host + */ + readonly host?: string; + + /** + * Custom headers to set in the request. HTTP allows repeated headers. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#httpHeaders + */ + readonly httpHeaders?: HttpHeader[]; + + /** + * Path to access on the HTTP server. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#path + */ + readonly path?: string; + + /** + * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#port + */ + readonly port: IntOrString; + + /** + * Scheme to use for connecting to the host. Defaults to HTTP. + * + * @default HTTP. + * @schema io.k8s.api.core.v1.HTTPGetAction#scheme + */ + readonly scheme?: string; + +} + +/** + * TCPSocketAction describes an action based on opening a socket + * + * @schema io.k8s.api.core.v1.TCPSocketAction + */ +export interface TcpSocketAction { + /** + * Optional: Host name to connect to, defaults to the pod IP. + * + * @schema io.k8s.api.core.v1.TCPSocketAction#host + */ + readonly host?: string; + + /** + * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + * + * @schema io.k8s.api.core.v1.TCPSocketAction#port + */ + readonly port: IntOrString; + +} + +/** + * Adds and removes POSIX capabilities from running containers. + * + * @schema io.k8s.api.core.v1.Capabilities + */ +export interface Capabilities { + /** + * Added capabilities + * + * @schema io.k8s.api.core.v1.Capabilities#add + */ + readonly add?: string[]; + + /** + * Removed capabilities + * + * @schema io.k8s.api.core.v1.Capabilities#drop + */ + readonly drop?: string[]; + +} + +/** + * Maps a string key to a path within a volume. + * + * @schema io.k8s.api.core.v1.KeyToPath + */ +export interface KeyToPath { + /** + * The key to project. + * + * @schema io.k8s.api.core.v1.KeyToPath#key + */ + readonly key: string; + + /** + * Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @schema io.k8s.api.core.v1.KeyToPath#mode + */ + readonly mode?: number; + + /** + * The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + * + * @schema io.k8s.api.core.v1.KeyToPath#path + */ + readonly path: string; + +} + +/** + * DownwardAPIVolumeFile represents information to create the file containing the pod field + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile + */ +export interface DownwardApiVolumeFile { + /** + * Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#fieldRef + */ + readonly fieldRef?: ObjectFieldSelector; + + /** + * Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#mode + */ + readonly mode?: number; + + /** + * Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#path + */ + readonly path: string; + + /** + * Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#resourceFieldRef + */ + readonly resourceFieldRef?: ResourceFieldSelector; + +} + +/** + * Projection that may be projected along with other supported volume types + * + * @schema io.k8s.api.core.v1.VolumeProjection + */ +export interface VolumeProjection { + /** + * information about the configMap data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#configMap + */ + readonly configMap?: ConfigMapProjection; + + /** + * information about the downwardAPI data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#downwardAPI + */ + readonly downwardAPI?: DownwardApiProjection; + + /** + * information about the secret data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#secret + */ + readonly secret?: SecretProjection; + + /** + * information about the serviceAccountToken data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#serviceAccountToken + */ + readonly serviceAccountToken?: ServiceAccountTokenProjection; + +} + +/** + * HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath + */ +export interface HttpIngressPath { + /** + * Backend defines the referenced service endpoint to which the traffic will be forwarded to. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#backend + */ + readonly backend: IngressBackend; + + /** + * Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#path + */ + readonly path?: string; + +} + +/** + * IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. + * + * @schema io.k8s.api.networking.v1.IPBlock + */ +export interface IpBlock { + /** + * CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" + * + * @schema io.k8s.api.networking.v1.IPBlock#cidr + */ + readonly cidr: string; + + /** + * Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range + * + * @schema io.k8s.api.networking.v1.IPBlock#except + */ + readonly except?: string[]; + +} + +/** + * QueuingConfiguration holds the configuration parameters for queuing + * + * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration + */ +export interface QueuingConfiguration { + /** + * `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration#handSize + */ + readonly handSize?: number; + + /** + * `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration#queueLengthLimit + */ + readonly queueLengthLimit?: number; + + /** + * `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. + * + * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration#queues + */ + readonly queues?: number; + +} + +/** + * Selects a key from a ConfigMap. + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector + */ +export interface ConfigMapKeySelector { + /** + * The key to select. + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector#key + */ + readonly key: string; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap or its key must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector#optional + */ + readonly optional?: boolean; + +} + +/** + * ObjectFieldSelector selects an APIVersioned field of an object. + * + * @schema io.k8s.api.core.v1.ObjectFieldSelector + */ +export interface ObjectFieldSelector { + /** + * Version of the schema the FieldPath is written in terms of, defaults to "v1". + * + * @schema io.k8s.api.core.v1.ObjectFieldSelector#apiVersion + */ + readonly apiVersion?: string; + + /** + * Path of the field to select in the specified API version. + * + * @schema io.k8s.api.core.v1.ObjectFieldSelector#fieldPath + */ + readonly fieldPath: string; + +} + +/** + * ResourceFieldSelector represents container resources (cpu, memory) and their output format + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector + */ +export interface ResourceFieldSelector { + /** + * Container name: required for volumes, optional for env vars + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector#containerName + */ + readonly containerName?: string; + + /** + * Specifies the output format of the exposed resources, defaults to "1" + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector#divisor + */ + readonly divisor?: Quantity; + + /** + * Required: resource to select + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector#resource + */ + readonly resource: string; + +} + +/** + * SecretKeySelector selects a key of a Secret. + * + * @schema io.k8s.api.core.v1.SecretKeySelector + */ +export interface SecretKeySelector { + /** + * The key of the secret to select from. Must be a valid secret key. + * + * @schema io.k8s.api.core.v1.SecretKeySelector#key + */ + readonly key: string; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.SecretKeySelector#name + */ + readonly name?: string; + + /** + * Specify whether the Secret or its key must be defined + * + * @schema io.k8s.api.core.v1.SecretKeySelector#optional + */ + readonly optional?: boolean; + +} + +/** + * JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps + */ +export interface JsonSchemaProps { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#$ref + */ + readonly ref?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#$schema + */ + readonly schema?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#additionalItems + */ + readonly additionalItems?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#additionalProperties + */ + readonly additionalProperties?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#allOf + */ + readonly allOf?: JsonSchemaProps[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#anyOf + */ + readonly anyOf?: JsonSchemaProps[]; + + /** + * default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#default + */ + readonly default?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#definitions + */ + readonly definitions?: { [key: string]: JsonSchemaProps }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#dependencies + */ + readonly dependencies?: { [key: string]: any }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#description + */ + readonly description?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#enum + */ + readonly enum?: any[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#example + */ + readonly example?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#exclusiveMaximum + */ + readonly exclusiveMaximum?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#exclusiveMinimum + */ + readonly exclusiveMinimum?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#externalDocs + */ + readonly externalDocs?: ExternalDocumentation; + + /** + * format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: + +- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#format + */ + readonly format?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#id + */ + readonly id?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#items + */ + readonly items?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxItems + */ + readonly maxItems?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxLength + */ + readonly maxLength?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxProperties + */ + readonly maxProperties?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maximum + */ + readonly maximum?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minItems + */ + readonly minItems?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minLength + */ + readonly minLength?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minProperties + */ + readonly minProperties?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minimum + */ + readonly minimum?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#multipleOf + */ + readonly multipleOf?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#not + */ + readonly not?: JsonSchemaProps; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#nullable + */ + readonly nullable?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#oneOf + */ + readonly oneOf?: JsonSchemaProps[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#pattern + */ + readonly pattern?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#patternProperties + */ + readonly patternProperties?: { [key: string]: JsonSchemaProps }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#properties + */ + readonly properties?: { [key: string]: JsonSchemaProps }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#required + */ + readonly required?: string[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#title + */ + readonly title?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#type + */ + readonly type?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#uniqueItems + */ + readonly uniqueItems?: boolean; + +} + +/** + * CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale + */ +export interface CustomResourceSubresourceScale { + /** + * labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#labelSelectorPath + */ + readonly labelSelectorPath?: string; + + /** + * specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#specReplicasPath + */ + readonly specReplicasPath: string; + + /** + * statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#statusReplicasPath + */ + readonly statusReplicasPath: string; + +} + +/** + * A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement + */ +export interface NodeSelectorRequirement { + /** + * The label key that the selector applies to. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement#key + */ + readonly key: string; + + /** + * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement#operator + */ + readonly operator: string; + + /** + * An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement#values + */ + readonly values?: string[]; + +} + +/** + * HTTPHeader describes a custom header to be used in HTTP probes + * + * @schema io.k8s.api.core.v1.HTTPHeader + */ +export interface HttpHeader { + /** + * The header field name + * + * @schema io.k8s.api.core.v1.HTTPHeader#name + */ + readonly name: string; + + /** + * The header field value + * + * @schema io.k8s.api.core.v1.HTTPHeader#value + */ + readonly value: string; + +} + +/** + * Adapts a ConfigMap into a projected volume. + +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. + * + * @schema io.k8s.api.core.v1.ConfigMapProjection + */ +export interface ConfigMapProjection { + /** + * If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.ConfigMapProjection#items + */ + readonly items?: KeyToPath[]; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapProjection#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap or its keys must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapProjection#optional + */ + readonly optional?: boolean; + +} + +/** + * Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. + * + * @schema io.k8s.api.core.v1.DownwardAPIProjection + */ +export interface DownwardApiProjection { + /** + * Items is a list of DownwardAPIVolume file + * + * @schema io.k8s.api.core.v1.DownwardAPIProjection#items + */ + readonly items?: DownwardApiVolumeFile[]; + +} + +/** + * Adapts a secret into a projected volume. + +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. + * + * @schema io.k8s.api.core.v1.SecretProjection + */ +export interface SecretProjection { + /** + * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.SecretProjection#items + */ + readonly items?: KeyToPath[]; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.SecretProjection#name + */ + readonly name?: string; + + /** + * Specify whether the Secret or its key must be defined + * + * @schema io.k8s.api.core.v1.SecretProjection#optional + */ + readonly optional?: boolean; + +} + +/** + * ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). + * + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection + */ +export interface ServiceAccountTokenProjection { + /** + * Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + * + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#audience + */ + readonly audience?: string; + + /** + * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + * + * @default 1 hour and must be at least 10 minutes. + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#expirationSeconds + */ + readonly expirationSeconds?: number; + + /** + * Path is the path relative to the mount point of the file to project the token into. + * + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#path + */ + readonly path: string; + +} + +/** + * ExternalDocumentation allows referencing an external resource for extended documentation. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation + */ +export interface ExternalDocumentation { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation#description + */ + readonly description?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation#url + */ + readonly url?: string; + +} + diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json index b015b80826d45..b4840d88c73c4 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json @@ -3342,11 +3342,6 @@ } ], "ForceUpdateEnabled": true, - "ScalingConfig": { - "DesiredSize": 1, - "MaxSize": 1, - "MinSize": 1 - }, "LaunchTemplate": { "Id": { "Ref": "LaunchTemplate" @@ -3357,6 +3352,11 @@ "DefaultVersionNumber" ] } + }, + "ScalingConfig": { + "DesiredSize": 1, + "MaxSize": 1, + "MinSize": 1 } } }, @@ -3416,6 +3416,43 @@ "UpdateReplacePolicy": "Delete", "DeletionPolicy": "Delete" }, + "Clustermanifestcdk8schart6B444884": { + "Type": "Custom::AWSCDK-EKS-KubernetesResource", + "Properties": { + "ServiceToken": { + "Fn::GetAtt": [ + "awscdkawseksKubectlProviderNestedStackawscdkawseksKubectlProviderNestedStackResourceA7AEBA6B", + "Outputs.awscdkeksclustertestawscdkawseksKubectlProviderframeworkonEventC681B49AArn" + ] + }, + "Manifest": { + "Fn::Join": [ + "", + [ + "[{\"apiVersion\":\"v1\",\"data\":{\"clusterName\":\"", + { + "Ref": "Cluster9EE0221C" + }, + "\"},\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"chart-config-map-95fdf26d\"}}]" + ] + ] + }, + "ClusterName": { + "Ref": "Cluster9EE0221C" + }, + "RoleArn": { + "Fn::GetAtt": [ + "ClusterCreationRole360249B6", + "Arn" + ] + } + }, + "DependsOn": [ + "ClusterKubectlReadyBarrier200052AF" + ], + "UpdateReplacePolicy": "Delete", + "DeletionPolicy": "Delete" + }, "ClustermanifestnginxnamespaceA68B4CE0": { "Type": "Custom::AWSCDK-EKS-KubernetesResource", "Properties": { @@ -3710,7 +3747,7 @@ }, "/", { - "Ref": "AssetParameters04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cfS3Bucket0E3AAAB9" + "Ref": "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3BucketB88F8513" }, "/", { @@ -3720,7 +3757,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cfS3VersionKey8C90C4EF" + "Ref": "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3VersionKey26664BF8" } ] } @@ -3733,7 +3770,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cfS3VersionKey8C90C4EF" + "Ref": "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3VersionKey26664BF8" } ] } @@ -3749,17 +3786,17 @@ "Arn" ] }, - "referencetoawscdkeksclustertestAssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4S3BucketAAB1A713Ref": { - "Ref": "AssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4S3Bucket086F94BB" + "referencetoawscdkeksclustertestAssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3Bucket1516DB0ARef": { + "Ref": "AssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3Bucket14D204F9" }, - "referencetoawscdkeksclustertestAssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4S3VersionKey481F0807Ref": { - "Ref": "AssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4S3VersionKeyA4B5C598" + "referencetoawscdkeksclustertestAssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3VersionKey2B8F3ED3Ref": { + "Ref": "AssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3VersionKeyDE8A2F1F" }, - "referencetoawscdkeksclustertestAssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3Bucket85526CA7Ref": { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3BucketD25BCC90" + "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3BucketB9F274F7Ref": { + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0" }, - "referencetoawscdkeksclustertestAssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey46BA60C1Ref": { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey72DFE7A5" + "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey6A81B439Ref": { + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" } } } @@ -3777,7 +3814,7 @@ }, "/", { - "Ref": "AssetParameters215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11S3BucketC456B560" + "Ref": "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3Bucket670DC328" }, "/", { @@ -3787,7 +3824,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11S3VersionKeyA1DAD649" + "Ref": "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3VersionKeyD4E56B7F" } ] } @@ -3800,7 +3837,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11S3VersionKeyA1DAD649" + "Ref": "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3VersionKeyD4E56B7F" } ] } @@ -3843,11 +3880,11 @@ "ClusterSecurityGroupId" ] }, - "referencetoawscdkeksclustertestAssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3Bucket85526CA7Ref": { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3BucketD25BCC90" + "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3BucketB9F274F7Ref": { + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0" }, - "referencetoawscdkeksclustertestAssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey46BA60C1Ref": { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey72DFE7A5" + "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey6A81B439Ref": { + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" } } } @@ -4271,7 +4308,7 @@ "Properties": { "Code": { "S3Bucket": { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3BucketD25BCC90" + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0" }, "S3Key": { "Fn::Join": [ @@ -4284,7 +4321,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey72DFE7A5" + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" } ] } @@ -4297,7 +4334,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey72DFE7A5" + "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" } ] } @@ -4458,29 +4495,29 @@ } }, "Parameters": { - "AssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4S3Bucket086F94BB": { + "AssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3Bucket14D204F9": { "Type": "String", - "Description": "S3 bucket for asset \"7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4\"" + "Description": "S3 bucket for asset \"87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dba\"" }, - "AssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4S3VersionKeyA4B5C598": { + "AssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3VersionKeyDE8A2F1F": { "Type": "String", - "Description": "S3 key for asset version \"7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4\"" + "Description": "S3 key for asset version \"87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dba\"" }, - "AssetParameters7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4ArtifactHash9B26D532": { + "AssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaArtifactHash54822A43": { "Type": "String", - "Description": "Artifact hash for asset \"7997347617940455774a736af2df2e6238c13b755ad25353a3d081446cfc80a4\"" + "Description": "Artifact hash for asset \"87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dba\"" }, - "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3BucketD25BCC90": { + "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0": { "Type": "String", - "Description": "S3 bucket for asset \"34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1\"" + "Description": "S3 bucket for asset \"5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0c\"" }, - "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1S3VersionKey72DFE7A5": { + "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A": { "Type": "String", - "Description": "S3 key for asset version \"34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1\"" + "Description": "S3 key for asset version \"5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0c\"" }, - "AssetParameters34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1ArtifactHashAA0236EE": { + "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cArtifactHash67988836": { "Type": "String", - "Description": "Artifact hash for asset \"34131c2e554ab57ad3a47fc0a13173a5c2a4b65a7582fe9622277b3d04c8e1e1\"" + "Description": "Artifact hash for asset \"5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0c\"" }, "AssetParametersb7d8a9750f8bfded8ac76be100e3bee1c3d4824df006766110d023f42952f5c2S3Bucket9ABBD5A2": { "Type": "String", @@ -4530,29 +4567,29 @@ "Type": "String", "Description": "Artifact hash for asset \"2acc31b34c05692ab3ea9831a27e5f241cffb21857e633d8256b8f0ebf5f3f43\"" }, - "AssetParameters04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cfS3Bucket0E3AAAB9": { + "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3BucketB88F8513": { "Type": "String", - "Description": "S3 bucket for asset \"04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cf\"" + "Description": "S3 bucket for asset \"4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128a\"" }, - "AssetParameters04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cfS3VersionKey8C90C4EF": { + "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3VersionKey26664BF8": { "Type": "String", - "Description": "S3 key for asset version \"04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cf\"" + "Description": "S3 key for asset version \"4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128a\"" }, - "AssetParameters04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cfArtifactHash1CDB946A": { + "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aArtifactHash19301AD9": { "Type": "String", - "Description": "Artifact hash for asset \"04fa2d485a51abd8261468eb6fa053d3a72242fc068fa75683232a52960b30cf\"" + "Description": "Artifact hash for asset \"4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128a\"" }, - "AssetParameters215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11S3BucketC456B560": { + "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3Bucket670DC328": { "Type": "String", - "Description": "S3 bucket for asset \"215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11\"" + "Description": "S3 bucket for asset \"3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136\"" }, - "AssetParameters215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11S3VersionKeyA1DAD649": { + "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3VersionKeyD4E56B7F": { "Type": "String", - "Description": "S3 key for asset version \"215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11\"" + "Description": "S3 key for asset version \"3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136\"" }, - "AssetParameters215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11ArtifactHash95B6846D": { + "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136ArtifactHash7D7D6F72": { "Type": "String", - "Description": "Artifact hash for asset \"215e9f40bd76e7102c690b24b0922eb4963d2d24938eec175e107db683455d11\"" + "Description": "Artifact hash for asset \"3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136\"" }, "SsmParameterValueawsserviceeksoptimizedami117amazonlinux2recommendedimageidC96584B6F00A464EAD1953AFF4B05118Parameter": { "Type": "AWS::SSM::Parameter::Value", diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts index 7f399939344f9..3d1c5cd1d98e3 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts @@ -3,8 +3,10 @@ import * as ec2 from '@aws-cdk/aws-ec2'; import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import { App, CfnOutput, Duration, Token, Fn } from '@aws-cdk/core'; +import * as cdk8s from 'cdk8s'; import * as eks from '../lib'; import * as hello from './hello-k8s'; +import * as k8s from './imports/k8s-v1_17_0'; import { Pinger } from './pinger/pinger'; import { TestStack } from './util'; @@ -58,6 +60,8 @@ class EksClusterStack extends TestStack { this.assertSimpleHelmChart(); + this.assertSimpleCdk8sChart(); + this.assertCreateNamespace(); this.assertServiceAccount(); @@ -101,6 +105,19 @@ class EksClusterStack extends TestStack { } + + private assertSimpleCdk8sChart() { + const app = new cdk8s.App(); + const chart = new cdk8s.Chart(app, 'Chart'); + + new k8s.ConfigMap(chart, 'config-map', { + data: { + clusterName: this.cluster.clusterName, + }, + }); + + this.cluster.addCdk8sChart('cdk8s-chart', chart); + } private assertSimpleHelmChart() { // deploy the Kubernetes dashboard through a helm chart this.cluster.addChart('dashboard', { diff --git a/packages/@aws-cdk/aws-eks/test/test.cluster.ts b/packages/@aws-cdk/aws-eks/test/test.cluster.ts index cd32b5ce42566..3230608a25bd9 100644 --- a/packages/@aws-cdk/aws-eks/test/test.cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/test.cluster.ts @@ -7,6 +7,7 @@ import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import * as lambda from '@aws-cdk/aws-lambda'; import * as cdk from '@aws-cdk/core'; +import * as cdk8s from 'cdk8s'; import { Test } from 'nodeunit'; import * as YAML from 'yaml'; import * as eks from '../lib'; @@ -20,6 +21,49 @@ const CLUSTER_VERSION = eks.KubernetesVersion.V1_16; export = { + 'cdk8s chart can be added to cluster'(test: Test) { + + const { stack } = testFixture(); + + const cluster = new eks.Cluster(stack, 'Cluster', { + version: eks.KubernetesVersion.V1_17, + }); + + const app = new cdk8s.App(); + const chart = new cdk8s.Chart(app, 'Chart'); + + new cdk8s.ApiObject(chart, 'FakePod', { + apiVersion: 'v1', + kind: 'Pod', + metadata: { + name: 'fake-pod', + labels: { + // adding aws-cdk token to cdk8s chart + clusterName: cluster.clusterName, + }, + }, + }); + + cluster.addCdk8sChart('cdk8s-chart', chart); + + expect(stack).to(haveResourceLike('Custom::AWSCDK-EKS-KubernetesResource', { + Manifest: { + 'Fn::Join': [ + '', + [ + '[{"apiVersion":"v1","kind":"Pod","metadata":{"labels":{"clusterName":"', + { + Ref: 'Cluster9EE0221C', + }, + '"},"name":"fake-pod"}}]', + ], + ], + }, + })); + + test.done(); + }, + 'cluster connections include both control plane and cluster security group'(test: Test) { const { stack } = testFixture(); diff --git a/yarn.lock b/yarn.lock index 074fb6bae06ee..f343d78d5871b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1084,6 +1084,17 @@ resolved "https://registry.yarnpkg.com/@istanbuljs/schema/-/schema-0.1.2.tgz#26520bf09abe4a5644cd5414e37125a8954241dd" integrity sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw== +"@jest/console@^25.5.0": + version "25.5.0" + resolved "https://registry.yarnpkg.com/@jest/console/-/console-25.5.0.tgz#770800799d510f37329c508a9edd0b7b447d9abb" + integrity sha512-T48kZa6MK1Y6k4b89sexwmSF4YLeZS/Udqg3Jj3jG/cHH+N/sLFCEoXEDMOKugJQ9FxPN1osxIknvKkxt6MKyw== + dependencies: + "@jest/types" "^25.5.0" + chalk "^3.0.0" + jest-message-util "^25.5.0" + jest-util "^25.5.0" + slash "^3.0.0" + "@jest/console@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/console/-/console-26.3.0.tgz#ed04063efb280c88ba87388b6f16427c0a85c856" @@ -1096,6 +1107,40 @@ jest-util "^26.3.0" slash "^3.0.0" +"@jest/core@^25.5.4": + version "25.5.4" + resolved "https://registry.yarnpkg.com/@jest/core/-/core-25.5.4.tgz#3ef7412f7339210f003cdf36646bbca786efe7b4" + integrity sha512-3uSo7laYxF00Dg/DMgbn4xMJKmDdWvZnf89n8Xj/5/AeQ2dOQmn6b6Hkj/MleyzZWXpwv+WSdYWl4cLsy2JsoA== + dependencies: + "@jest/console" "^25.5.0" + "@jest/reporters" "^25.5.1" + "@jest/test-result" "^25.5.0" + "@jest/transform" "^25.5.1" + "@jest/types" "^25.5.0" + ansi-escapes "^4.2.1" + chalk "^3.0.0" + exit "^0.1.2" + graceful-fs "^4.2.4" + jest-changed-files "^25.5.0" + jest-config "^25.5.4" + jest-haste-map "^25.5.1" + jest-message-util "^25.5.0" + jest-regex-util "^25.2.6" + jest-resolve "^25.5.1" + jest-resolve-dependencies "^25.5.4" + jest-runner "^25.5.4" + jest-runtime "^25.5.4" + jest-snapshot "^25.5.1" + jest-util "^25.5.0" + jest-validate "^25.5.0" + jest-watcher "^25.5.0" + micromatch "^4.0.2" + p-each-series "^2.1.0" + realpath-native "^2.0.0" + rimraf "^3.0.0" + slash "^3.0.0" + strip-ansi "^6.0.0" + "@jest/core@^26.4.2": version "26.4.2" resolved "https://registry.yarnpkg.com/@jest/core/-/core-26.4.2.tgz#85d0894f31ac29b5bab07aa86806d03dd3d33edc" @@ -1130,6 +1175,15 @@ slash "^3.0.0" strip-ansi "^6.0.0" +"@jest/environment@^25.5.0": + version "25.5.0" + resolved "https://registry.yarnpkg.com/@jest/environment/-/environment-25.5.0.tgz#aa33b0c21a716c65686638e7ef816c0e3a0c7b37" + integrity sha512-U2VXPEqL07E/V7pSZMSQCvV5Ea4lqOlT+0ZFijl/i316cRMHvZ4qC+jBdryd+lmRetjQo0YIQr6cVPNxxK87mA== + dependencies: + "@jest/fake-timers" "^25.5.0" + "@jest/types" "^25.5.0" + jest-mock "^25.5.0" + "@jest/environment@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/environment/-/environment-26.3.0.tgz#e6953ab711ae3e44754a025f838bde1a7fd236a0" @@ -1140,6 +1194,17 @@ "@types/node" "*" jest-mock "^26.3.0" +"@jest/fake-timers@^25.5.0": + version "25.5.0" + resolved "https://registry.yarnpkg.com/@jest/fake-timers/-/fake-timers-25.5.0.tgz#46352e00533c024c90c2bc2ad9f2959f7f114185" + integrity sha512-9y2+uGnESw/oyOI3eww9yaxdZyHq7XvprfP/eeoCsjqKYts2yRlsHS/SgjPDV8FyMfn2nbMy8YzUk6nyvdLOpQ== + dependencies: + "@jest/types" "^25.5.0" + jest-message-util "^25.5.0" + jest-mock "^25.5.0" + jest-util "^25.5.0" + lolex "^5.0.0" + "@jest/fake-timers@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/fake-timers/-/fake-timers-26.3.0.tgz#f515d4667a6770f60ae06ae050f4e001126c666a" @@ -1152,6 +1217,15 @@ jest-mock "^26.3.0" jest-util "^26.3.0" +"@jest/globals@^25.5.2": + version "25.5.2" + resolved "https://registry.yarnpkg.com/@jest/globals/-/globals-25.5.2.tgz#5e45e9de8d228716af3257eeb3991cc2e162ca88" + integrity sha512-AgAS/Ny7Q2RCIj5kZ+0MuKM1wbF0WMLxbCVl/GOMoCNbODRdJ541IxJ98xnZdVSZXivKpJlNPIWa3QmY0l4CXA== + dependencies: + "@jest/environment" "^25.5.0" + "@jest/types" "^25.5.0" + expect "^25.5.0" + "@jest/globals@^26.4.2": version "26.4.2" resolved "https://registry.yarnpkg.com/@jest/globals/-/globals-26.4.2.tgz#73c2a862ac691d998889a241beb3dc9cada40d4a" @@ -1161,6 +1235,38 @@ "@jest/types" "^26.3.0" expect "^26.4.2" +"@jest/reporters@^25.5.1": + version "25.5.1" + resolved "https://registry.yarnpkg.com/@jest/reporters/-/reporters-25.5.1.tgz#cb686bcc680f664c2dbaf7ed873e93aa6811538b" + integrity sha512-3jbd8pPDTuhYJ7vqiHXbSwTJQNavczPs+f1kRprRDxETeE3u6srJ+f0NPuwvOmk+lmunZzPkYWIFZDLHQPkviw== + dependencies: + "@bcoe/v8-coverage" "^0.2.3" + "@jest/console" "^25.5.0" + "@jest/test-result" "^25.5.0" + "@jest/transform" "^25.5.1" + "@jest/types" "^25.5.0" + chalk "^3.0.0" + collect-v8-coverage "^1.0.0" + exit "^0.1.2" + glob "^7.1.2" + graceful-fs "^4.2.4" + istanbul-lib-coverage "^3.0.0" + istanbul-lib-instrument "^4.0.0" + istanbul-lib-report "^3.0.0" + istanbul-lib-source-maps "^4.0.0" + istanbul-reports "^3.0.2" + jest-haste-map "^25.5.1" + jest-resolve "^25.5.1" + jest-util "^25.5.0" + jest-worker "^25.5.0" + slash "^3.0.0" + source-map "^0.6.0" + string-length "^3.1.0" + terminal-link "^2.0.0" + v8-to-istanbul "^4.1.3" + optionalDependencies: + node-notifier "^6.0.0" + "@jest/reporters@^26.4.1": version "26.4.1" resolved "https://registry.yarnpkg.com/@jest/reporters/-/reporters-26.4.1.tgz#3b4d6faf28650f3965f8b97bc3d114077fb71795" @@ -1193,6 +1299,15 @@ optionalDependencies: node-notifier "^8.0.0" +"@jest/source-map@^25.5.0": + version "25.5.0" + resolved "https://registry.yarnpkg.com/@jest/source-map/-/source-map-25.5.0.tgz#df5c20d6050aa292c2c6d3f0d2c7606af315bd1b" + integrity sha512-eIGx0xN12yVpMcPaVpjXPnn3N30QGJCJQSkEDUt9x1fI1Gdvb07Ml6K5iN2hG7NmMP6FDmtPEssE3z6doOYUwQ== + dependencies: + callsites "^3.0.0" + graceful-fs "^4.2.4" + source-map "^0.6.0" + "@jest/source-map@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/source-map/-/source-map-26.3.0.tgz#0e646e519883c14c551f7b5ae4ff5f1bfe4fc3d9" @@ -1202,6 +1317,16 @@ graceful-fs "^4.2.4" source-map "^0.6.0" +"@jest/test-result@^25.5.0": + version "25.5.0" + resolved "https://registry.yarnpkg.com/@jest/test-result/-/test-result-25.5.0.tgz#139a043230cdeffe9ba2d8341b27f2efc77ce87c" + integrity sha512-oV+hPJgXN7IQf/fHWkcS99y0smKLU2czLBJ9WA0jHITLst58HpQMtzSYxzaBvYc6U5U6jfoMthqsUlUlbRXs0A== + dependencies: + "@jest/console" "^25.5.0" + "@jest/types" "^25.5.0" + "@types/istanbul-lib-coverage" "^2.0.0" + collect-v8-coverage "^1.0.0" + "@jest/test-result@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/test-result/-/test-result-26.3.0.tgz#46cde01fa10c0aaeb7431bf71e4a20d885bc7fdb" @@ -1212,6 +1337,17 @@ "@types/istanbul-lib-coverage" "^2.0.0" collect-v8-coverage "^1.0.0" +"@jest/test-sequencer@^25.5.4": + version "25.5.4" + resolved "https://registry.yarnpkg.com/@jest/test-sequencer/-/test-sequencer-25.5.4.tgz#9b4e685b36954c38d0f052e596d28161bdc8b737" + integrity sha512-pTJGEkSeg1EkCO2YWq6hbFvKNXk8ejqlxiOg1jBNLnWrgXOkdY6UmqZpwGFXNnRt9B8nO1uWMzLLZ4eCmhkPNA== + dependencies: + "@jest/test-result" "^25.5.0" + graceful-fs "^4.2.4" + jest-haste-map "^25.5.1" + jest-runner "^25.5.4" + jest-runtime "^25.5.4" + "@jest/test-sequencer@^26.4.2": version "26.4.2" resolved "https://registry.yarnpkg.com/@jest/test-sequencer/-/test-sequencer-26.4.2.tgz#58a3760a61eec758a2ce6080201424580d97cbba" @@ -1223,6 +1359,28 @@ jest-runner "^26.4.2" jest-runtime "^26.4.2" +"@jest/transform@^25.5.1": + version "25.5.1" + resolved "https://registry.yarnpkg.com/@jest/transform/-/transform-25.5.1.tgz#0469ddc17699dd2bf985db55fa0fb9309f5c2db3" + integrity sha512-Y8CEoVwXb4QwA6Y/9uDkn0Xfz0finGkieuV0xkdF9UtZGJeLukD5nLkaVrVsODB1ojRWlaoD0AJZpVHCSnJEvg== + dependencies: + "@babel/core" "^7.1.0" + "@jest/types" "^25.5.0" + babel-plugin-istanbul "^6.0.0" + chalk "^3.0.0" + convert-source-map "^1.4.0" + fast-json-stable-stringify "^2.0.0" + graceful-fs "^4.2.4" + jest-haste-map "^25.5.1" + jest-regex-util "^25.2.6" + jest-util "^25.5.0" + micromatch "^4.0.2" + pirates "^4.0.1" + realpath-native "^2.0.0" + slash "^3.0.0" + source-map "^0.6.1" + write-file-atomic "^3.0.0" + "@jest/transform@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/transform/-/transform-26.3.0.tgz#c393e0e01459da8a8bfc6d2a7c2ece1a13e8ba55" @@ -2993,7 +3151,7 @@ jest-diff "^25.2.1" pretty-format "^25.2.1" -"@types/jest@^26.0.14": +"@types/jest@^26.0.10", "@types/jest@^26.0.14": version "26.0.14" resolved "https://registry.yarnpkg.com/@types/jest/-/jest-26.0.14.tgz#078695f8f65cb55c5a98450d65083b2b73e5a3f3" integrity sha512-Hz5q8Vu0D288x3iWXePSn53W7hAjP0H7EQ6QvDO9c7t46mR0lNOLlfuwQ+JkVxuhygHzlzPX+0jKdA3ZgSh+Vg== @@ -3082,6 +3240,11 @@ resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0" integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA== +"@types/prettier@^1.19.0": + version "1.19.1" + resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-1.19.1.tgz#33509849f8e679e4add158959fdb086440e9553f" + integrity sha512-5qOlnZscTn4xxM5MeGXAMOsIOIKIbh9e85zJWfBRVPlRMEVawzoPhINYbRGkBZCI8LxvBe7tJCdWiarA99OZfQ== + "@types/prettier@^2.0.0": version "2.0.2" resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.0.2.tgz#5bb52ee68d0f8efa9cc0099920e56be6cc4e37f3" @@ -3286,7 +3449,7 @@ abortcontroller-polyfill@^1.1.9: resolved "https://registry.yarnpkg.com/abortcontroller-polyfill/-/abortcontroller-polyfill-1.5.0.tgz#2c562f530869abbcf88d949a2b60d1d402e87a7c" integrity sha512-O6Xk757Jb4o0LMzMOMdWvxpHWrQzruYBaUruFaIOfAQRnWFxfdXYobw12jrVHGtoXk6WiiyYzc0QWN9aL62HQA== -acorn-globals@^4.3.0: +acorn-globals@^4.3.0, acorn-globals@^4.3.2: version "4.3.4" resolved "https://registry.yarnpkg.com/acorn-globals/-/acorn-globals-4.3.4.tgz#9fa1926addc11c97308c4e66d7add0d40c3272e7" integrity sha512-clfQEh21R+D0leSbUdWf3OcfqyaCSAQ8Ryq00bofSekfr9W8u1jyYZo6ir0xu9Gtcf7BjcHJpnbZH7JOCpP60A== @@ -3322,7 +3485,7 @@ acorn@^6.0.1, acorn@^6.0.4: resolved "https://registry.yarnpkg.com/acorn/-/acorn-6.4.1.tgz#531e58ba3f51b9dacb9a6646ca4debf5b14ca474" integrity sha512-ZVA9k326Nwrj3Cj9jlh3wGFutC2ZornPNARZwsNYqQYgN0EsV2d53w5RN/co65Ohn4sUAUtb1rSUAOD6XN9idA== -acorn@^7.1.1, acorn@^7.4.0: +acorn@^7.1.0, acorn@^7.1.1, acorn@^7.4.0: version "7.4.0" resolved "https://registry.yarnpkg.com/acorn/-/acorn-7.4.0.tgz#e1ad486e6c54501634c6c397c5c121daa383607c" integrity sha512-+G7P8jJmCHr+S+cLfQxygbWhXy+8YTVGzAkpEbcLo2mLoL7tij/VG41QSHACSf5QgYRhMZYHuNc6drJaO0Da+w== @@ -3788,6 +3951,20 @@ axios@^0.19.0: dependencies: follow-redirects "1.5.10" +babel-jest@^25.5.1: + version "25.5.1" + resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-25.5.1.tgz#bc2e6101f849d6f6aec09720ffc7bc5332e62853" + integrity sha512-9dA9+GmMjIzgPnYtkhBg73gOo/RHqPmLruP3BaGL4KEX3Dwz6pI8auSN8G8+iuEG90+GSswyKvslN+JYSaacaQ== + dependencies: + "@jest/transform" "^25.5.1" + "@jest/types" "^25.5.0" + "@types/babel__core" "^7.1.7" + babel-plugin-istanbul "^6.0.0" + babel-preset-jest "^25.5.0" + chalk "^3.0.0" + graceful-fs "^4.2.4" + slash "^3.0.0" + babel-jest@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-26.3.0.tgz#10d0ca4b529ca3e7d1417855ef7d7bd6fc0c3463" @@ -3820,6 +3997,15 @@ babel-plugin-istanbul@^6.0.0: istanbul-lib-instrument "^4.0.0" test-exclude "^6.0.0" +babel-plugin-jest-hoist@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-25.5.0.tgz#129c80ba5c7fc75baf3a45b93e2e372d57ca2677" + integrity sha512-u+/W+WAjMlvoocYGTwthAiQSxDcJAyHpQ6oWlHdFZaaN+Rlk8Q7iiwDPg2lN/FyJtAYnKjFxbn7xus4HCFkg5g== + dependencies: + "@babel/template" "^7.3.3" + "@babel/types" "^7.3.3" + "@types/babel__traverse" "^7.0.6" + babel-plugin-jest-hoist@^26.2.0: version "26.2.0" resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-26.2.0.tgz#bdd0011df0d3d513e5e95f76bd53b51147aca2dd" @@ -3830,7 +4016,7 @@ babel-plugin-jest-hoist@^26.2.0: "@types/babel__core" "^7.0.0" "@types/babel__traverse" "^7.0.6" -babel-preset-current-node-syntax@^0.1.3: +babel-preset-current-node-syntax@^0.1.2, babel-preset-current-node-syntax@^0.1.3: version "0.1.3" resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-0.1.3.tgz#b4b547acddbf963cba555ba9f9cbbb70bfd044da" integrity sha512-uyexu1sVwcdFnyq9o8UQYsXwXflIh8LvrF5+cKrYam93ned1CStffB3+BEcsxGSgagoA3GEyjDqO4a/58hyPYQ== @@ -3847,6 +4033,14 @@ babel-preset-current-node-syntax@^0.1.3: "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" "@babel/plugin-syntax-optional-chaining" "^7.8.3" +babel-preset-jest@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-25.5.0.tgz#c1d7f191829487a907764c65307faa0e66590b49" + integrity sha512-8ZczygctQkBU+63DtSOKGh7tFL0CeCuz+1ieud9lJ1WPQ9O6A1a/r+LGn6Y705PA6whHQ3T1XuB/PmpfNYf8Fw== + dependencies: + babel-plugin-jest-hoist "^25.5.0" + babel-preset-current-node-syntax "^0.1.2" + babel-preset-jest@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-26.3.0.tgz#ed6344506225c065fd8a0b53e191986f74890776" @@ -3965,6 +4159,13 @@ browser-process-hrtime@^1.0.0: resolved "https://registry.yarnpkg.com/browser-process-hrtime/-/browser-process-hrtime-1.0.0.tgz#3c9b4b7d782c8121e56f10106d84c0d0ffc94626" integrity sha512-9o5UecI3GhkpM6DrXr69PblIuWxPKk9Y0jHBRhdocZ2y7YECBFCsHm79Pr3OyR2AvjhDkabFJaDJMYRazHgsow== +browser-resolve@^1.11.3: + version "1.11.3" + resolved "https://registry.yarnpkg.com/browser-resolve/-/browser-resolve-1.11.3.tgz#9b7cbb3d0f510e4cb86bdbd796124d28b5890af6" + integrity sha512-exDi1BYWB/6raKHmDTCicQfTkqwN5fioMFV4j8BsfMU4R2DK/QfZfK7kOVkmWCNANf0snkBzqGqAJBao9gZMdQ== + dependencies: + resolve "1.1.7" + browserify-aes@^1.0.0, browserify-aes@^1.0.4: version "1.2.0" resolved "https://registry.yarnpkg.com/browserify-aes/-/browserify-aes-1.2.0.tgz#326734642f403dabc3003209853bb70ad428ef48" @@ -4280,6 +4481,14 @@ caseless@~0.12.0: resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc" integrity sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw= +"cdk8s@file:../../awslabs/cdk8s/packages/cdk8s/dist/js/cdk8s-0.28.0.jsii.tgz": + version "0.28.0" + resolved "file:../../awslabs/cdk8s/packages/cdk8s/dist/js/cdk8s-0.28.0.jsii.tgz#48102ed10a9367ba5e77fd687d3fd0dd27920ba5" + dependencies: + follow-redirects "^1.11.0" + json-stable-stringify "^1.0.1" + yaml "^1.7.2" + chalk@^1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98" @@ -5243,7 +5452,7 @@ cssom@0.3.x, cssom@^0.3.4, cssom@~0.3.6: resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.3.8.tgz#9f1276f5b2b463f2114d3f2c75250af8c1a36f4a" integrity sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg== -cssom@^0.4.4: +cssom@^0.4.1, cssom@^0.4.4: version "0.4.4" resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.4.4.tgz#5a66cf93d2d0b661d80bf6a44fb65f5c2e4e0a10" integrity sha512-p3pvU7r1MyyqbTk+WbNJIgJjG2VmTIaB10rI93LzVPrmDJKkzKYMtxxyAvQXR/NS6otuzveI7+7BBq3SjBS2mw== @@ -5255,7 +5464,7 @@ cssstyle@^1.1.1: dependencies: cssom "0.3.x" -cssstyle@^2.2.0: +cssstyle@^2.0.0, cssstyle@^2.2.0: version "2.3.0" resolved "https://registry.yarnpkg.com/cssstyle/-/cssstyle-2.3.0.tgz#ff665a0ddbdc31864b09647f34163443d90b0852" integrity sha512-AZL67abkUzIuvcHqk7c09cezpGNcxUxU4Ioi/05xHk4DQeTkWmGYftIE6ctU6AEt+Gn4n1lDStOtj7FKycP71A== @@ -5950,7 +6159,7 @@ escape-string-regexp@^4.0.0: resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== -escodegen@1.x.x, escodegen@^1.11.0, escodegen@^1.14.1: +escodegen@1.x.x, escodegen@^1.11.0, escodegen@^1.11.1, escodegen@^1.14.1: version "1.14.3" resolved "https://registry.yarnpkg.com/escodegen/-/escodegen-1.14.3.tgz#4e7b81fba61581dc97582ed78cab7f0e8d63f503" integrity sha512-qFcX0XJkdg+PB3xjZZG/wKSuT1PnQWx57+TVSjIMmILd2yC/6ByYElPwJnslDsuWuSAp4AwJGumarAAmJch5Kw== @@ -6230,6 +6439,22 @@ execa@^1.0.0: signal-exit "^3.0.0" strip-eof "^1.0.0" +execa@^3.2.0: + version "3.4.0" + resolved "https://registry.yarnpkg.com/execa/-/execa-3.4.0.tgz#c08ed4550ef65d858fac269ffc8572446f37eb89" + integrity sha512-r9vdGQk4bmCuK1yKQu1KTwcT2zwfWdbdaXfCtAh+5nU/4fSX+JAb7vZGvI5naJrQlvONrEB20jeruESI69530g== + dependencies: + cross-spawn "^7.0.0" + get-stream "^5.0.0" + human-signals "^1.1.1" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.0" + onetime "^5.1.0" + p-finally "^2.0.0" + signal-exit "^3.0.2" + strip-final-newline "^2.0.0" + execa@^4.0.0, execa@^4.0.3: version "4.0.3" resolved "https://registry.yarnpkg.com/execa/-/execa-4.0.3.tgz#0a34dabbad6d66100bd6f2c576c8669403f317f2" @@ -6263,6 +6488,18 @@ expand-brackets@^2.1.4: snapdragon "^0.8.1" to-regex "^3.0.1" +expect@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/expect/-/expect-25.5.0.tgz#f07f848712a2813bb59167da3fb828ca21f58bba" + integrity sha512-w7KAXo0+6qqZZhovCaBVPSIqQp7/UTcx4M9uKt2m6pd2VB1voyC8JizLRqeEqud3AAVP02g+hbErDu5gu64tlA== + dependencies: + "@jest/types" "^25.5.0" + ansi-styles "^4.0.0" + jest-get-type "^25.2.6" + jest-matcher-utils "^25.5.0" + jest-message-util "^25.5.0" + jest-regex-util "^25.2.6" + expect@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/expect/-/expect-26.4.2.tgz#36db120928a5a2d7d9736643032de32f24e1b2a1" @@ -6579,7 +6816,7 @@ follow-redirects@1.5.10: dependencies: debug "=3.1.0" -follow-redirects@^1.0.0: +follow-redirects@^1.0.0, follow-redirects@^1.11.0: version "1.13.0" resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.13.0.tgz#b42e8d93a2a7eea5ed88633676d6597bc8e384db" integrity sha512-aq6gF1BEKje4a9i9+5jimNFIpq4Q1WiwBToeRK5NvZBd/TRsmW8BsJfOEGkr76TbOyPVD3OVDN910EcUNtRYEA== @@ -8022,6 +8259,15 @@ istanbul-reports@^3.0.2: html-escaper "^2.0.0" istanbul-lib-report "^3.0.0" +jest-changed-files@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-25.5.0.tgz#141cc23567ceb3f534526f8614ba39421383634c" + integrity sha512-EOw9QEqapsDT7mKF162m8HFzRPbmP8qJQny6ldVOdOVBz3ACgPm/1nAn5fPQ/NDaYhX/AHkrGwwkCncpAVSXcw== + dependencies: + "@jest/types" "^25.5.0" + execa "^3.2.0" + throat "^5.0.0" + jest-changed-files@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-26.3.0.tgz#68fb2a7eb125f50839dab1f5a17db3607fe195b1" @@ -8031,6 +8277,26 @@ jest-changed-files@^26.3.0: execa "^4.0.0" throat "^5.0.0" +jest-cli@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-25.5.4.tgz#b9f1a84d1301a92c5c217684cb79840831db9f0d" + integrity sha512-rG8uJkIiOUpnREh1768/N3n27Cm+xPFkSNFO91tgg+8o2rXeVLStz+vkXkGr4UtzH6t1SNbjwoiswd7p4AhHTw== + dependencies: + "@jest/core" "^25.5.4" + "@jest/test-result" "^25.5.0" + "@jest/types" "^25.5.0" + chalk "^3.0.0" + exit "^0.1.2" + graceful-fs "^4.2.4" + import-local "^3.0.2" + is-ci "^2.0.0" + jest-config "^25.5.4" + jest-util "^25.5.0" + jest-validate "^25.5.0" + prompts "^2.0.1" + realpath-native "^2.0.0" + yargs "^15.3.1" + jest-cli@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-26.4.2.tgz#24afc6e4dfc25cde4c7ec4226fb7db5f157c21da" @@ -8050,6 +8316,31 @@ jest-cli@^26.4.2: prompts "^2.0.1" yargs "^15.3.1" +jest-config@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-25.5.4.tgz#38e2057b3f976ef7309b2b2c8dcd2a708a67f02c" + integrity sha512-SZwR91SwcdK6bz7Gco8qL7YY2sx8tFJYzvg216DLihTWf+LKY/DoJXpM9nTzYakSyfblbqeU48p/p7Jzy05Atg== + dependencies: + "@babel/core" "^7.1.0" + "@jest/test-sequencer" "^25.5.4" + "@jest/types" "^25.5.0" + babel-jest "^25.5.1" + chalk "^3.0.0" + deepmerge "^4.2.2" + glob "^7.1.1" + graceful-fs "^4.2.4" + jest-environment-jsdom "^25.5.0" + jest-environment-node "^25.5.0" + jest-get-type "^25.2.6" + jest-jasmine2 "^25.5.4" + jest-regex-util "^25.2.6" + jest-resolve "^25.5.1" + jest-util "^25.5.0" + jest-validate "^25.5.0" + micromatch "^4.0.2" + pretty-format "^25.5.0" + realpath-native "^2.0.0" + jest-config@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-26.4.2.tgz#da0cbb7dc2c131ffe831f0f7f2a36256e6086558" @@ -8074,7 +8365,7 @@ jest-config@^26.4.2: micromatch "^4.0.2" pretty-format "^26.4.2" -jest-diff@^25.2.1: +jest-diff@^25.2.1, jest-diff@^25.5.0: version "25.5.0" resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-25.5.0.tgz#1dd26ed64f96667c068cef026b677dfa01afcfa9" integrity sha512-z1kygetuPiREYdNIumRpAHY6RXiGmp70YHptjdaxTWGmA085W3iCnXNx0DhflK3vwrKmrRWyY1wUpkPMVxMK7A== @@ -8094,6 +8385,13 @@ jest-diff@^26.4.2: jest-get-type "^26.3.0" pretty-format "^26.4.2" +jest-docblock@^25.3.0: + version "25.3.0" + resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-25.3.0.tgz#8b777a27e3477cd77a168c05290c471a575623ef" + integrity sha512-aktF0kCar8+zxRHxQZwxMy70stc9R1mOmrLsT5VO3pIT0uzGRSDAXxSlz4NqQWpuLjPpuMhPRl7H+5FRsvIQAg== + dependencies: + detect-newline "^3.0.0" + jest-docblock@^26.0.0: version "26.0.0" resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-26.0.0.tgz#3e2fa20899fc928cb13bd0ff68bd3711a36889b5" @@ -8101,6 +8399,17 @@ jest-docblock@^26.0.0: dependencies: detect-newline "^3.0.0" +jest-each@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-each/-/jest-each-25.5.0.tgz#0c3c2797e8225cb7bec7e4d249dcd96b934be516" + integrity sha512-QBogUxna3D8vtiItvn54xXde7+vuzqRrEeaw8r1s+1TG9eZLVJE5ZkKoSUlqFwRjnlaA4hyKGiu9OlkFIuKnjA== + dependencies: + "@jest/types" "^25.5.0" + chalk "^3.0.0" + jest-get-type "^25.2.6" + jest-util "^25.5.0" + pretty-format "^25.5.0" + jest-each@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-each/-/jest-each-26.4.2.tgz#bb14f7f4304f2bb2e2b81f783f989449b8b6ffae" @@ -8112,6 +8421,18 @@ jest-each@^26.4.2: jest-util "^26.3.0" pretty-format "^26.4.2" +jest-environment-jsdom@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-environment-jsdom/-/jest-environment-jsdom-25.5.0.tgz#dcbe4da2ea997707997040ecf6e2560aec4e9834" + integrity sha512-7Jr02ydaq4jaWMZLY+Skn8wL5nVIYpWvmeatOHL3tOcV3Zw8sjnPpx+ZdeBfc457p8jCR9J6YCc+Lga0oIy62A== + dependencies: + "@jest/environment" "^25.5.0" + "@jest/fake-timers" "^25.5.0" + "@jest/types" "^25.5.0" + jest-mock "^25.5.0" + jest-util "^25.5.0" + jsdom "^15.2.1" + jest-environment-jsdom@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-environment-jsdom/-/jest-environment-jsdom-26.3.0.tgz#3b749ba0f3a78e92ba2c9ce519e16e5dd515220c" @@ -8125,6 +8446,18 @@ jest-environment-jsdom@^26.3.0: jest-util "^26.3.0" jsdom "^16.2.2" +jest-environment-node@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-25.5.0.tgz#0f55270d94804902988e64adca37c6ce0f7d07a1" + integrity sha512-iuxK6rQR2En9EID+2k+IBs5fCFd919gVVK5BeND82fYeLWPqvRcFNPKu9+gxTwfB5XwBGBvZ0HFQa+cHtIoslA== + dependencies: + "@jest/environment" "^25.5.0" + "@jest/fake-timers" "^25.5.0" + "@jest/types" "^25.5.0" + jest-mock "^25.5.0" + jest-util "^25.5.0" + semver "^6.3.0" + jest-environment-node@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-26.3.0.tgz#56c6cfb506d1597f94ee8d717072bda7228df849" @@ -8147,6 +8480,26 @@ jest-get-type@^26.3.0: resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-26.3.0.tgz#e97dc3c3f53c2b406ca7afaed4493b1d099199e0" integrity sha512-TpfaviN1R2pQWkIihlfEanwOXK0zcxrKEE4MlU6Tn7keoXdN6/3gK/xl0yEh8DOunn5pOVGKf8hB4R9gVh04ig== +jest-haste-map@^25.5.1: + version "25.5.1" + resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-25.5.1.tgz#1df10f716c1d94e60a1ebf7798c9fb3da2620943" + integrity sha512-dddgh9UZjV7SCDQUrQ+5t9yy8iEgKc1AKqZR9YDww8xsVOtzPQSMVLDChc21+g29oTRexb9/B0bIlZL+sWmvAQ== + dependencies: + "@jest/types" "^25.5.0" + "@types/graceful-fs" "^4.1.2" + anymatch "^3.0.3" + fb-watchman "^2.0.0" + graceful-fs "^4.2.4" + jest-serializer "^25.5.0" + jest-util "^25.5.0" + jest-worker "^25.5.0" + micromatch "^4.0.2" + sane "^4.0.3" + walker "^1.0.7" + which "^2.0.2" + optionalDependencies: + fsevents "^2.1.2" + jest-haste-map@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-26.3.0.tgz#c51a3b40100d53ab777bfdad382d2e7a00e5c726" @@ -8168,6 +8521,29 @@ jest-haste-map@^26.3.0: optionalDependencies: fsevents "^2.1.2" +jest-jasmine2@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest-jasmine2/-/jest-jasmine2-25.5.4.tgz#66ca8b328fb1a3c5364816f8958f6970a8526968" + integrity sha512-9acbWEfbmS8UpdcfqnDO+uBUgKa/9hcRh983IHdM+pKmJPL77G0sWAAK0V0kr5LK3a8cSBfkFSoncXwQlRZfkQ== + dependencies: + "@babel/traverse" "^7.1.0" + "@jest/environment" "^25.5.0" + "@jest/source-map" "^25.5.0" + "@jest/test-result" "^25.5.0" + "@jest/types" "^25.5.0" + chalk "^3.0.0" + co "^4.6.0" + expect "^25.5.0" + is-generator-fn "^2.0.0" + jest-each "^25.5.0" + jest-matcher-utils "^25.5.0" + jest-message-util "^25.5.0" + jest-runtime "^25.5.4" + jest-snapshot "^25.5.1" + jest-util "^25.5.0" + pretty-format "^25.5.0" + throat "^5.0.0" + jest-jasmine2@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-jasmine2/-/jest-jasmine2-26.4.2.tgz#18a9d5bec30904267ac5e9797570932aec1e2257" @@ -8202,6 +8578,14 @@ jest-junit@^11.1.0: uuid "^3.3.3" xml "^1.0.1" +jest-leak-detector@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-25.5.0.tgz#2291c6294b0ce404241bb56fe60e2d0c3e34f0bb" + integrity sha512-rV7JdLsanS8OkdDpZtgBf61L5xZ4NnYLBq72r6ldxahJWWczZjXawRsoHyXzibM5ed7C2QRjpp6ypgwGdKyoVA== + dependencies: + jest-get-type "^25.2.6" + pretty-format "^25.5.0" + jest-leak-detector@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-26.4.2.tgz#c73e2fa8757bf905f6f66fb9e0070b70fa0f573f" @@ -8210,6 +8594,16 @@ jest-leak-detector@^26.4.2: jest-get-type "^26.3.0" pretty-format "^26.4.2" +jest-matcher-utils@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-25.5.0.tgz#fbc98a12d730e5d2453d7f1ed4a4d948e34b7867" + integrity sha512-VWI269+9JS5cpndnpCwm7dy7JtGQT30UHfrnM3mXl22gHGt/b7NkjBqXfbhZ8V4B7ANUsjK18PlSBmG0YH7gjw== + dependencies: + chalk "^3.0.0" + jest-diff "^25.5.0" + jest-get-type "^25.2.6" + pretty-format "^25.5.0" + jest-matcher-utils@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-26.4.2.tgz#fa81f3693f7cb67e5fc1537317525ef3b85f4b06" @@ -8220,6 +8614,20 @@ jest-matcher-utils@^26.4.2: jest-get-type "^26.3.0" pretty-format "^26.4.2" +jest-message-util@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-25.5.0.tgz#ea11d93204cc7ae97456e1d8716251185b8880ea" + integrity sha512-ezddz3YCT/LT0SKAmylVyWWIGYoKHOFOFXx3/nA4m794lfVUskMcwhip6vTgdVrOtYdjeQeis2ypzes9mZb4EA== + dependencies: + "@babel/code-frame" "^7.0.0" + "@jest/types" "^25.5.0" + "@types/stack-utils" "^1.0.1" + chalk "^3.0.0" + graceful-fs "^4.2.4" + micromatch "^4.0.2" + slash "^3.0.0" + stack-utils "^1.0.1" + jest-message-util@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-26.3.0.tgz#3bdb538af27bb417f2d4d16557606fd082d5841a" @@ -8234,6 +8642,13 @@ jest-message-util@^26.3.0: slash "^3.0.0" stack-utils "^2.0.2" +jest-mock@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-25.5.0.tgz#a91a54dabd14e37ecd61665d6b6e06360a55387a" + integrity sha512-eXWuTV8mKzp/ovHc5+3USJMYsTBhyQ+5A1Mak35dey/RG8GlM4YWVylZuGgVXinaW6tpvk/RSecmF37FKUlpXA== + dependencies: + "@jest/types" "^25.5.0" + jest-mock@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-26.3.0.tgz#ee62207c3c5ebe5f35b760e1267fee19a1cfdeba" @@ -8242,16 +8657,30 @@ jest-mock@^26.3.0: "@jest/types" "^26.3.0" "@types/node" "*" -jest-pnp-resolver@^1.2.2: +jest-pnp-resolver@^1.2.1, jest-pnp-resolver@^1.2.2: version "1.2.2" resolved "https://registry.yarnpkg.com/jest-pnp-resolver/-/jest-pnp-resolver-1.2.2.tgz#b704ac0ae028a89108a4d040b3f919dfddc8e33c" integrity sha512-olV41bKSMm8BdnuMsewT4jqlZ8+3TCARAXjZGT9jcoSnrfUnRCqnMoF9XEeoWjbzObpqF9dRhHQj0Xb9QdF6/w== +jest-regex-util@^25.2.6: + version "25.2.6" + resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-25.2.6.tgz#d847d38ba15d2118d3b06390056028d0f2fd3964" + integrity sha512-KQqf7a0NrtCkYmZZzodPftn7fL1cq3GQAFVMn5Hg8uKx/fIenLEobNanUxb7abQ1sjADHBseG/2FGpsv/wr+Qw== + jest-regex-util@^26.0.0: version "26.0.0" resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-26.0.0.tgz#d25e7184b36e39fd466c3bc41be0971e821fee28" integrity sha512-Gv3ZIs/nA48/Zvjrl34bf+oD76JHiGDUxNOVgUjh3j890sblXryjY4rss71fPtD/njchl6PSE2hIhvyWa1eT0A== +jest-resolve-dependencies@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-25.5.4.tgz#85501f53957c8e3be446e863a74777b5a17397a7" + integrity sha512-yFmbPd+DAQjJQg88HveObcGBA32nqNZ02fjYmtL16t1xw9bAttSn5UGRRhzMHIQbsep7znWvAvnD4kDqOFM0Uw== + dependencies: + "@jest/types" "^25.5.0" + jest-regex-util "^25.2.6" + jest-snapshot "^25.5.1" + jest-resolve-dependencies@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-26.4.2.tgz#739bdb027c14befb2fe5aabbd03f7bab355f1dc5" @@ -8261,6 +8690,21 @@ jest-resolve-dependencies@^26.4.2: jest-regex-util "^26.0.0" jest-snapshot "^26.4.2" +jest-resolve@^25.5.1: + version "25.5.1" + resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-25.5.1.tgz#0e6fbcfa7c26d2a5fe8f456088dc332a79266829" + integrity sha512-Hc09hYch5aWdtejsUZhA+vSzcotf7fajSlPA6EZPE1RmPBAD39XtJhvHWFStid58iit4IPDLI/Da4cwdDmAHiQ== + dependencies: + "@jest/types" "^25.5.0" + browser-resolve "^1.11.3" + chalk "^3.0.0" + graceful-fs "^4.2.4" + jest-pnp-resolver "^1.2.1" + read-pkg-up "^7.0.1" + realpath-native "^2.0.0" + resolve "^1.17.0" + slash "^3.0.0" + jest-resolve@^26.4.0: version "26.4.0" resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-26.4.0.tgz#6dc0af7fb93e65b73fec0368ca2b76f3eb59a6d7" @@ -8275,6 +8719,31 @@ jest-resolve@^26.4.0: resolve "^1.17.0" slash "^3.0.0" +jest-runner@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest-runner/-/jest-runner-25.5.4.tgz#ffec5df3875da5f5c878ae6d0a17b8e4ecd7c71d" + integrity sha512-V/2R7fKZo6blP8E9BL9vJ8aTU4TH2beuqGNxHbxi6t14XzTb+x90B3FRgdvuHm41GY8ch4xxvf0ATH4hdpjTqg== + dependencies: + "@jest/console" "^25.5.0" + "@jest/environment" "^25.5.0" + "@jest/test-result" "^25.5.0" + "@jest/types" "^25.5.0" + chalk "^3.0.0" + exit "^0.1.2" + graceful-fs "^4.2.4" + jest-config "^25.5.4" + jest-docblock "^25.3.0" + jest-haste-map "^25.5.1" + jest-jasmine2 "^25.5.4" + jest-leak-detector "^25.5.0" + jest-message-util "^25.5.0" + jest-resolve "^25.5.1" + jest-runtime "^25.5.4" + jest-util "^25.5.0" + jest-worker "^25.5.0" + source-map-support "^0.5.6" + throat "^5.0.0" + jest-runner@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-runner/-/jest-runner-26.4.2.tgz#c3ec5482c8edd31973bd3935df5a449a45b5b853" @@ -8301,6 +8770,38 @@ jest-runner@^26.4.2: source-map-support "^0.5.6" throat "^5.0.0" +jest-runtime@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-25.5.4.tgz#dc981fe2cb2137abcd319e74ccae7f7eeffbfaab" + integrity sha512-RWTt8LeWh3GvjYtASH2eezkc8AehVoWKK20udV6n3/gC87wlTbE1kIA+opCvNWyyPeBs6ptYsc6nyHUb1GlUVQ== + dependencies: + "@jest/console" "^25.5.0" + "@jest/environment" "^25.5.0" + "@jest/globals" "^25.5.2" + "@jest/source-map" "^25.5.0" + "@jest/test-result" "^25.5.0" + "@jest/transform" "^25.5.1" + "@jest/types" "^25.5.0" + "@types/yargs" "^15.0.0" + chalk "^3.0.0" + collect-v8-coverage "^1.0.0" + exit "^0.1.2" + glob "^7.1.3" + graceful-fs "^4.2.4" + jest-config "^25.5.4" + jest-haste-map "^25.5.1" + jest-message-util "^25.5.0" + jest-mock "^25.5.0" + jest-regex-util "^25.2.6" + jest-resolve "^25.5.1" + jest-snapshot "^25.5.1" + jest-util "^25.5.0" + jest-validate "^25.5.0" + realpath-native "^2.0.0" + slash "^3.0.0" + strip-bom "^4.0.0" + yargs "^15.3.1" + jest-runtime@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-26.4.2.tgz#94ce17890353c92e4206580c73a8f0c024c33c42" @@ -8333,6 +8834,13 @@ jest-runtime@^26.4.2: strip-bom "^4.0.0" yargs "^15.3.1" +jest-serializer@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-serializer/-/jest-serializer-25.5.0.tgz#a993f484e769b4ed54e70e0efdb74007f503072b" + integrity sha512-LxD8fY1lByomEPflwur9o4e2a5twSQ7TaVNLlFUuToIdoJuBt8tzHfCsZ42Ok6LkKXWzFWf3AGmheuLAA7LcCA== + dependencies: + graceful-fs "^4.2.4" + jest-serializer@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-serializer/-/jest-serializer-26.3.0.tgz#1c9d5e1b74d6e5f7e7f9627080fa205d976c33ef" @@ -8341,6 +8849,27 @@ jest-serializer@^26.3.0: "@types/node" "*" graceful-fs "^4.2.4" +jest-snapshot@^25.5.1: + version "25.5.1" + resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-25.5.1.tgz#1a2a576491f9961eb8d00c2e5fd479bc28e5ff7f" + integrity sha512-C02JE1TUe64p2v1auUJ2ze5vcuv32tkv9PyhEb318e8XOKF7MOyXdJ7kdjbvrp3ChPLU2usI7Rjxs97Dj5P0uQ== + dependencies: + "@babel/types" "^7.0.0" + "@jest/types" "^25.5.0" + "@types/prettier" "^1.19.0" + chalk "^3.0.0" + expect "^25.5.0" + graceful-fs "^4.2.4" + jest-diff "^25.5.0" + jest-get-type "^25.2.6" + jest-matcher-utils "^25.5.0" + jest-message-util "^25.5.0" + jest-resolve "^25.5.1" + make-dir "^3.0.0" + natural-compare "^1.4.0" + pretty-format "^25.5.0" + semver "^6.3.0" + jest-snapshot@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-26.4.2.tgz#87d3ac2f2bd87ea8003602fbebd8fcb9e94104f6" @@ -8374,6 +8903,29 @@ jest-util@26.x, jest-util@^26.3.0: is-ci "^2.0.0" micromatch "^4.0.2" +jest-util@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-25.5.0.tgz#31c63b5d6e901274d264a4fec849230aa3fa35b0" + integrity sha512-KVlX+WWg1zUTB9ktvhsg2PXZVdkI1NBevOJSkTKYAyXyH4QSvh+Lay/e/v+bmaFfrkfx43xD8QTfgobzlEXdIA== + dependencies: + "@jest/types" "^25.5.0" + chalk "^3.0.0" + graceful-fs "^4.2.4" + is-ci "^2.0.0" + make-dir "^3.0.0" + +jest-validate@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-25.5.0.tgz#fb4c93f332c2e4cf70151a628e58a35e459a413a" + integrity sha512-okUFKqhZIpo3jDdtUXUZ2LxGUZJIlfdYBvZb1aczzxrlyMlqdnnws9MOxezoLGhSaFc2XYaHNReNQfj5zPIWyQ== + dependencies: + "@jest/types" "^25.5.0" + camelcase "^5.3.1" + chalk "^3.0.0" + jest-get-type "^25.2.6" + leven "^3.1.0" + pretty-format "^25.5.0" + jest-validate@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-26.4.2.tgz#e871b0dfe97747133014dcf6445ee8018398f39c" @@ -8386,6 +8938,18 @@ jest-validate@^26.4.2: leven "^3.1.0" pretty-format "^26.4.2" +jest-watcher@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-watcher/-/jest-watcher-25.5.0.tgz#d6110d101df98badebe435003956fd4a465e8456" + integrity sha512-XrSfJnVASEl+5+bb51V0Q7WQx65dTSk7NL4yDdVjPnRNpM0hG+ncFmDYJo9O8jaSRcAitVbuVawyXCRoxGrT5Q== + dependencies: + "@jest/test-result" "^25.5.0" + "@jest/types" "^25.5.0" + ansi-escapes "^4.2.1" + chalk "^3.0.0" + jest-util "^25.5.0" + string-length "^3.1.0" + jest-watcher@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-watcher/-/jest-watcher-26.3.0.tgz#f8ef3068ddb8af160ef868400318dc4a898eed08" @@ -8399,6 +8963,14 @@ jest-watcher@^26.3.0: jest-util "^26.3.0" string-length "^4.0.1" +jest-worker@^25.5.0: + version "25.5.0" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-25.5.0.tgz#2611d071b79cea0f43ee57a3d118593ac1547db1" + integrity sha512-/dsSmUkIy5EBGfv/IjjqmFxrNAUpBERfGs1oHROyD7yxjG/w+t0GOJDX8O1k32ySmd7+a5IhnJU2qQFcJ4n1vw== + dependencies: + merge-stream "^2.0.0" + supports-color "^7.0.0" + jest-worker@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-26.3.0.tgz#7c8a97e4f4364b4f05ed8bca8ca0c24de091871f" @@ -8408,6 +8980,15 @@ jest-worker@^26.3.0: merge-stream "^2.0.0" supports-color "^7.0.0" +jest@^25.5.4: + version "25.5.4" + resolved "https://registry.yarnpkg.com/jest/-/jest-25.5.4.tgz#f21107b6489cfe32b076ce2adcadee3587acb9db" + integrity sha512-hHFJROBTqZahnO+X+PMtT6G2/ztqAZJveGqz//FnWWHurizkD05PQGzRZOhF3XP6z7SJmL+5tCfW8qV06JypwQ== + dependencies: + "@jest/core" "^25.5.4" + import-local "^3.0.2" + jest-cli "^25.5.4" + jest@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest/-/jest-26.4.2.tgz#7e8bfb348ec33f5459adeaffc1a25d5752d9d312" @@ -8482,6 +9063,38 @@ jsdom@^14.1.0: ws "^6.1.2" xml-name-validator "^3.0.0" +jsdom@^15.2.1: + version "15.2.1" + resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-15.2.1.tgz#d2feb1aef7183f86be521b8c6833ff5296d07ec5" + integrity sha512-fAl1W0/7T2G5vURSyxBzrJ1LSdQn6Tr5UX/xD4PXDx/PDgwygedfW6El/KIj3xJ7FU61TTYnc/l/B7P49Eqt6g== + dependencies: + abab "^2.0.0" + acorn "^7.1.0" + acorn-globals "^4.3.2" + array-equal "^1.0.0" + cssom "^0.4.1" + cssstyle "^2.0.0" + data-urls "^1.1.0" + domexception "^1.0.1" + escodegen "^1.11.1" + html-encoding-sniffer "^1.0.2" + nwsapi "^2.2.0" + parse5 "5.1.0" + pn "^1.1.0" + request "^2.88.0" + request-promise-native "^1.0.7" + saxes "^3.1.9" + symbol-tree "^3.2.2" + tough-cookie "^3.0.1" + w3c-hr-time "^1.0.1" + w3c-xmlserializer "^1.1.2" + webidl-conversions "^4.0.2" + whatwg-encoding "^1.0.5" + whatwg-mimetype "^2.3.0" + whatwg-url "^7.0.0" + ws "^7.0.0" + xml-name-validator "^3.0.0" + jsdom@^16.2.2: version "16.4.0" resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-16.4.0.tgz#36005bde2d136f73eee1a830c6d45e55408edddb" @@ -9074,6 +9687,13 @@ log4js@^6.3.0: rfdc "^1.1.4" streamroller "^2.2.4" +lolex@^5.0.0: + version "5.1.2" + resolved "https://registry.yarnpkg.com/lolex/-/lolex-5.1.2.tgz#953694d098ce7c07bc5ed6d0e42bc6c0c6d5a367" + integrity sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A== + dependencies: + "@sinonjs/commons" "^1.7.0" + loose-envify@^1.0.0, loose-envify@^1.1.0, loose-envify@^1.4.0: version "1.4.0" resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" @@ -9669,6 +10289,17 @@ node-modules-regexp@^1.0.0: resolved "https://registry.yarnpkg.com/node-modules-regexp/-/node-modules-regexp-1.0.0.tgz#8d9dbe28964a4ac5712e9131642107c71e90ec40" integrity sha1-jZ2+KJZKSsVxLpExZCEHxx6Q7EA= +node-notifier@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/node-notifier/-/node-notifier-6.0.0.tgz#cea319e06baa16deec8ce5cd7f133c4a46b68e12" + integrity sha512-SVfQ/wMw+DesunOm5cKqr6yDcvUTDl/yc97ybGHMrteNEY6oekXpNpS3lZwgLlwz0FLgHoiW28ZpmBHUDg37cw== + dependencies: + growly "^1.3.0" + is-wsl "^2.1.1" + semver "^6.3.0" + shellwords "^0.1.1" + which "^1.3.1" + node-notifier@^8.0.0: version "8.0.0" resolved "https://registry.yarnpkg.com/node-notifier/-/node-notifier-8.0.0.tgz#a7eee2d51da6d0f7ff5094bc7108c911240c1620" @@ -10131,6 +10762,11 @@ p-finally@^1.0.0: resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae" integrity sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4= +p-finally@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-2.0.1.tgz#bd6fcaa9c559a096b680806f4d657b3f0f240561" + integrity sha512-vpm09aKwq6H9phqRQzecoDpD8TmVyGw70qmWlyq5onxY7tqyTTFVvxMykxQSQKILBSFlbXpypIw2T1Ml7+DDtw== + p-limit@^1.1.0: version "1.3.0" resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-1.3.0.tgz#b86bd5f0c25690911c7590fcbfc2010d54b3ccb8" @@ -11390,6 +12026,11 @@ readdir-scoped-modules@^1.0.0: graceful-fs "^4.1.2" once "^1.3.0" +realpath-native@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/realpath-native/-/realpath-native-2.0.0.tgz#7377ac429b6e1fd599dc38d08ed942d0d7beb866" + integrity sha512-v1SEYUOXXdbBZK8ZuNgO4TBjamPsiSgcFr0aP+tEKpQZK8vooEUqV6nm6Cv502mX4NF2EfsnVqtNAHG+/6Ur1Q== + rechoir@^0.6.2: version "0.6.2" resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.6.2.tgz#85204b54dba82d5742e28c96756ef43af50e3384" @@ -11526,7 +12167,7 @@ request-promise-core@1.1.4: dependencies: lodash "^4.17.19" -request-promise-native@^1.0.5, request-promise-native@^1.0.8: +request-promise-native@^1.0.5, request-promise-native@^1.0.7, request-promise-native@^1.0.8: version "1.0.9" resolved "https://registry.yarnpkg.com/request-promise-native/-/request-promise-native-1.0.9.tgz#e407120526a5efdc9a39b28a5679bf47b9d9dc28" integrity sha512-wcW+sIUiWnKgNY0dqCpOZkUbF/I+YPi+f09JZIDa39Ec+q82CpSYniDp+ISgTTbKmnpJWASeJBPZmoxH84wt3g== @@ -11610,6 +12251,11 @@ resolve-url@^0.2.1: resolved "https://registry.yarnpkg.com/resolve-url/-/resolve-url-0.2.1.tgz#2c637fe77c893afd2a663fe21aa9080068e2052a" integrity sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo= +resolve@1.1.7: + version "1.1.7" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.1.7.tgz#203114d82ad2c5ed9e8e0411b3932875e889e97b" + integrity sha1-IDEU2CrSxe2ejgQRs5ModeiJ6Xs= + resolve@^1.1.6, resolve@^1.10.0, resolve@^1.10.1, resolve@^1.11.1, resolve@^1.12.0, resolve@^1.13.1, resolve@^1.17.0, resolve@^1.3.2: version "1.17.0" resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.17.0.tgz#b25941b54968231cc2d1bb76a79cb7f2c0bf8444" @@ -12203,7 +12849,7 @@ stable@^0.1.8: resolved "https://registry.yarnpkg.com/stable/-/stable-0.1.8.tgz#836eb3c8382fe2936feaf544631017ce7d47a3cf" integrity sha512-ji9qxRnOVfcuLDySj9qzhGSEFVobyt1kIOSkj1qZzYLzq7Tos/oUUWvotUPQLlrsidqsK6tBH89Bc9kL5zHA6w== -stack-utils@^1.0.2: +stack-utils@^1.0.1, stack-utils@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/stack-utils/-/stack-utils-1.0.2.tgz#33eba3897788558bebfc2db059dc158ec36cebb8" integrity sha512-MTX+MeG5U994cazkjd/9KNAapsHnibjMLnfXodlkXw76JEea0UiNzrqidzo1emMwk7w5Qhc9jd4Bn9TBb1MFwA== @@ -12291,6 +12937,14 @@ string-argv@0.3.1: resolved "https://registry.yarnpkg.com/string-argv/-/string-argv-0.3.1.tgz#95e2fbec0427ae19184935f816d74aaa4c5c19da" integrity sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg== +string-length@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/string-length/-/string-length-3.1.0.tgz#107ef8c23456e187a8abd4a61162ff4ac6e25837" + integrity sha512-Ttp5YvkGm5v9Ijagtaz1BnN+k9ObpvS0eIBblPMp2YWL8FBmi9qblQ9fexc2k/CXFgrTIteU3jAw3payCnwSTA== + dependencies: + astral-regex "^1.0.0" + strip-ansi "^5.2.0" + string-length@^4.0.1: version "4.0.1" resolved "https://registry.yarnpkg.com/string-length/-/string-length-4.0.1.tgz#4a973bf31ef77c4edbceadd6af2611996985f8a1" @@ -13352,6 +14006,15 @@ v8-compile-cache@^2.0.0, v8-compile-cache@^2.0.3: resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.1.1.tgz#54bc3cdd43317bca91e35dcaf305b1a7237de745" integrity sha512-8OQ9CL+VWyt3JStj7HX7/ciTL2V3Rl1Wf5OL+SNTm0yK1KvtReVulksyeRnCANHHuUxHlQig+JJDlUhBt1NQDQ== +v8-to-istanbul@^4.1.3: + version "4.1.4" + resolved "https://registry.yarnpkg.com/v8-to-istanbul/-/v8-to-istanbul-4.1.4.tgz#b97936f21c0e2d9996d4985e5c5156e9d4e49cd6" + integrity sha512-Rw6vJHj1mbdK8edjR7+zuJrpDtKIgNdAvTSAcpYfgMIw+u2dPDntD3dgN4XQFLU2/fvFQdzj+EeSGfd/jnY5fQ== + dependencies: + "@types/istanbul-lib-coverage" "^2.0.1" + convert-source-map "^1.6.0" + source-map "^0.7.3" + v8-to-istanbul@^5.0.1: version "5.0.1" resolved "https://registry.yarnpkg.com/v8-to-istanbul/-/v8-to-istanbul-5.0.1.tgz#0608f5b49a481458625edb058488607f25498ba5" @@ -13655,7 +14318,7 @@ ws@^6.1.2, ws@^6.2.0: dependencies: async-limiter "~1.0.0" -ws@^7.2.3: +ws@^7.0.0, ws@^7.2.3: version "7.3.1" resolved "https://registry.yarnpkg.com/ws/-/ws-7.3.1.tgz#d0547bf67f7ce4f12a72dfe31262c68d7dc551c8" integrity sha512-D3RuNkynyHmEJIpD2qrgVkc9DQ23OrN/moAwZX4L8DfvszsJxpjQuUq3LMx6HoYji9fbIOBY18XWBsAux1ZZUA== @@ -13733,7 +14396,7 @@ yallist@^4.0.0: resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== -yaml@*, yaml@1.10.0, yaml@^1.10.0, yaml@^1.5.0: +yaml@*, yaml@1.10.0, yaml@^1.10.0, yaml@^1.5.0, yaml@^1.7.2: version "1.10.0" resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.0.tgz#3b593add944876077d4d683fee01081bd9fff31e" integrity sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg== From 3add737abd1751b80b0394a0a68e35533d04cad4 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 13:24:22 +0300 Subject: [PATCH 06/36] working on new readme --- packages/@aws-cdk/aws-eks/GUIDE.md | 81 ++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 packages/@aws-cdk/aws-eks/GUIDE.md diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md new file mode 100644 index 0000000000000..e44f9e863b3d2 --- /dev/null +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -0,0 +1,81 @@ +## Amazon EKS Construct Library + +--- + +![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) + +> All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use. + +![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.svg?style=for-the-badge) + +> The APIs of higher level constructs in this module are in **developer preview** before they become stable. We will only make breaking changes to address unforeseen API issues. Therefore, these APIs are not subject to [Semantic Versioning](https://semver.org/), and breaking changes will be announced in release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package. + +--- + + +This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. +In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. + +1. [Overview](#overview) +2. [Quick Start](#quick-start) +3. [Provisioning clusters](#provisioning-clusters) + + - [Capacity](#capacity) + + - [Managed Node Groups](#managed-node-groups) + - [Fargate Profiles](#fargate-profiles) + - [Self Managed Auto Scaling Groups](#self-managed-auto-scaling-groups) + + - [VPC Support](#vpc-support) + + - [Endpoint Access](#endpoint-access) + + - [Permissions](#permissions) + +4. [Using existing clusters](#using-existing-clusters) +5. [Managing Objects](#managing-objects) + + - [Applying](#applying) + + - [Kubernetes Manifests](#kubernetes-manifests) + - [Helm Charts](#helm-charts) + + - [Patching](#patching) + - [Querying](#querying) +6. [Known Issues](#known-issues) + +## Overview + +## Quick Start + +## Provisioning clusters + +### Capacity + +#### Managed Node Groups + +#### Fargate Profiles + +#### Self Managed Auto Scaling Groups + +### VPC Support + +### Endpoint Access + +### Permissions + +## Using existing clusters + +## Managing Objects + +### Applying + +#### Kubernetes Manifests + +#### Helm Charts + +### Patching + +### Querying + +## Known Issues \ No newline at end of file From 6e00ef1fbe8c451756805634a19dc5c51071f1b2 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 13:29:26 +0300 Subject: [PATCH 07/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index e44f9e863b3d2..3c251d8dc5b30 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -16,33 +16,24 @@ This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. -1. [Overview](#overview) -2. [Quick Start](#quick-start) -3. [Provisioning clusters](#provisioning-clusters) - +* [Overview](#overview) +* [Quick Start](#quick-start) +* [Provisioning clusters](#provisioning-clusters) - [Capacity](#capacity) - - [Managed Node Groups](#managed-node-groups) - [Fargate Profiles](#fargate-profiles) - [Self Managed Auto Scaling Groups](#self-managed-auto-scaling-groups) - - [VPC Support](#vpc-support) - - [Endpoint Access](#endpoint-access) - - [Permissions](#permissions) - -4. [Using existing clusters](#using-existing-clusters) -5. [Managing Objects](#managing-objects) - +* [Using existing clusters](#using-existing-clusters) +* [Managing Objects](#managing-objects) - [Applying](#applying) - - [Kubernetes Manifests](#kubernetes-manifests) - [Helm Charts](#helm-charts) - - [Patching](#patching) - [Querying](#querying) -6. [Known Issues](#known-issues) +* [Known Issues](#known-issues) ## Overview From d661f856864e120d0c9617f27cc140d50c0b0e01 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 14:39:49 +0300 Subject: [PATCH 08/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 91 +++++++++++++++++++++++++----- 1 file changed, 77 insertions(+), 14 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index 3c251d8dc5b30..ec2f14ce7e8a9 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -16,43 +16,106 @@ This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. -* [Overview](#overview) * [Quick Start](#quick-start) +* [Overview](#overview) * [Provisioning clusters](#provisioning-clusters) - - [Capacity](#capacity) - - [Managed Node Groups](#managed-node-groups) - - [Fargate Profiles](#fargate-profiles) - - [Self Managed Auto Scaling Groups](#self-managed-auto-scaling-groups) - - [VPC Support](#vpc-support) - - [Endpoint Access](#endpoint-access) - - [Permissions](#permissions) + * [Capacity](#capacity) + * [Managed Node Groups](#managed-node-groups) + * [Fargate Profiles](#fargate-profiles) + * [Self Managed Auto Scaling Groups](#self-managed-auto-scaling-groups) + * [VPC Support](#vpc-support) + * [Endpoint Access](#endpoint-access) + * [Permissions](#permissions) * [Using existing clusters](#using-existing-clusters) * [Managing Objects](#managing-objects) - - [Applying](#applying) - - [Kubernetes Manifests](#kubernetes-manifests) - - [Helm Charts](#helm-charts) - - [Patching](#patching) - - [Querying](#querying) + * [Applying](#applying) + * [Kubernetes Manifests](#kubernetes-manifests) + * [Helm Charts](#helm-charts) + * [Patching](#patching) + * [Querying](#querying) * [Known Issues](#known-issues) +## Quick Start + + + ## Overview -## Quick Start +```text + +-----------------------------------------------+ +-----------------+ + | EKS Cluster | kubectl | | + |-----------------------------------------------|<-------------+| Kubectl Handler | + | | | | + | | +-----------------+ + | +--------------------+ +-----------------+ | + | | | | | | + | | Managed Node Group | | Fargate Profile | | +-----------------+ + | | | | | | | | + | +--------------------+ +-----------------+ | | Cluster Handler | + | | | | + +-----------------------------------------------+ +-----------------+ + ^ ^ + + | | | + | connect self managed capacity | | aws-sdk + | | create/update/delete | + + | v + +--------------------+ + +-------------------+ + | | --------------+| eks.amazonaws.com | + | Auto Scaling Group | +-------------------+ + | | + +--------------------+ +``` + ## Provisioning clusters +Creating a new cluster is done using the `eks.Cluster` or `eks.FargateCluster` constructs. The only required property is the kubernetes version. + +```typescript +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, +}); +``` + +This will provision an Amazon EKS cluster with the following configuration: + +- Managed Node Group with 2 **m5.large** instances (this instance type suits most common use-cases, and is good value for money) +- Dedicated VPC with [default configuration](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc). + +There are various way to customize the cluster capacity, i.e, the amount and type of worker nodes in the cluster. + +You can also use `eks.FargateCluster` to provision a managed cluster that uses fargate workers. + ### Capacity + #### Managed Node Groups #### Fargate Profiles #### Self Managed Auto Scaling Groups + + ### VPC Support ### Endpoint Access +When you create a new cluster, Amazon EKS creates an endpoint for the managed Kubernetes API server that you use to communicate with your cluster (using Kubernetes management tools such as `kubectl`) + +By default, this API server endpoint is public to the internet, and access to the API server is secured using a combination of AWS Identity and Access Management (IAM) and native Kubernetes [Role Based Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC). + +You can configure the [cluster endpoint access](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) by using the `endpointAccess` property: + +```typescript +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_16, + endpointAccess: eks.EndpointAccess.PRIVATE // No access outside of your VPC. +}); +``` + +The default value is `eks.EndpointAccess.PUBLIC_AND_PRIVATE`. Which means the cluster endpoint is accessible from outside of your VPC, but worker node traffic and `kubectl` commands issued by this library stay within your VPC. + ### Permissions ## Using existing clusters From 1829e5cdac503ed779ccb8d23e9e646caa12843f Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 14:46:23 +0300 Subject: [PATCH 09/36] use published version cdk8s --- packages/@aws-cdk/aws-eks/lib/cluster.ts | 14 ++++++++++++++ packages/@aws-cdk/aws-eks/package.json | 4 ++-- .../@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts | 4 ++-- yarn.lock | 7 ++++--- 4 files changed, 22 insertions(+), 7 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/lib/cluster.ts b/packages/@aws-cdk/aws-eks/lib/cluster.ts index f874343c1ebab..6ca95c045511d 100644 --- a/packages/@aws-cdk/aws-eks/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/cluster.ts @@ -129,6 +129,13 @@ export interface ICluster extends IResource, ec2.IConnectable { */ addChart(id: string, options: HelmChartOptions): HelmChart; + /** + * Defines a CDK8s chart in this cluster. + * + * @param id logical id of this chart. + * @param chart the cdk8s chart. + * @returns a `KubernetesManifest` construct representing the chart. + */ addCdk8sChart(id: string, chart: cdk8s.Chart): KubernetesManifest; } @@ -616,6 +623,13 @@ abstract class ClusterBase extends Resource implements ICluster { return new HelmChart(this, `chart-${id}`, { cluster: this, ...options }); } + /** + * Defines a CDK8s chart in this cluster. + * + * @param id logical id of this chart. + * @param chart the cdk8s chart. + * @returns a `KubernetesManifest` construct representing the chart. + */ public addCdk8sChart(id: string, chart: cdk8s.Chart): KubernetesManifest { return this.addManifest(id, ...chart.toJson()); } diff --git a/packages/@aws-cdk/aws-eks/package.json b/packages/@aws-cdk/aws-eks/package.json index 281a33fe8a04d..e7369693877af 100644 --- a/packages/@aws-cdk/aws-eks/package.json +++ b/packages/@aws-cdk/aws-eks/package.json @@ -83,7 +83,7 @@ "@aws-cdk/aws-ssm": "0.0.0", "@aws-cdk/core": "0.0.0", "@aws-cdk/custom-resources": "0.0.0", - "cdk8s": "0.28.0", + "cdk8s": "^0.29.0", "constructs": "^3.0.4", "yaml": "1.10.0" }, @@ -100,7 +100,7 @@ "@aws-cdk/aws-ssm": "0.0.0", "@aws-cdk/core": "0.0.0", "@aws-cdk/custom-resources": "0.0.0", - "cdk8s": "0.28.0", + "cdk8s": "^0.29.0", "constructs": "^3.0.4" }, "engines": { diff --git a/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts b/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts index 9dc6024a5ef71..e1bfdd603cd14 100644 --- a/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts +++ b/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts @@ -636,7 +636,7 @@ export class CertificateSigningRequest extends ApiObject { } /** - * + * * * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList */ @@ -10890,7 +10890,7 @@ bigger numbers of ACS mean more reserved concurrent requests (at the expense of */ export enum IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind { /** DeleteOptions */ - DELETE_OPTIONS = "DeleteOptions", + DELETE_OPTIONS = 'DeleteOptions', } /** diff --git a/yarn.lock b/yarn.lock index f343d78d5871b..12f802c79983d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4481,9 +4481,10 @@ caseless@~0.12.0: resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc" integrity sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw= -"cdk8s@file:../../awslabs/cdk8s/packages/cdk8s/dist/js/cdk8s-0.28.0.jsii.tgz": - version "0.28.0" - resolved "file:../../awslabs/cdk8s/packages/cdk8s/dist/js/cdk8s-0.28.0.jsii.tgz#48102ed10a9367ba5e77fd687d3fd0dd27920ba5" +cdk8s@^0.29.0: + version "0.29.0" + resolved "https://registry.yarnpkg.com/cdk8s/-/cdk8s-0.29.0.tgz#3bf7861aef22c6401e5800a3c5b4d680f31d3eeb" + integrity sha512-MV/6qzdSqLjDRW1dEE2tCtgp4OxirqbagY04JOhW7z8rnveQA9p24iWXkupf4uebs3SmBuVVeDgupuH/MZZX8w== dependencies: follow-redirects "^1.11.0" json-stable-stringify "^1.0.1" From c7fa886942f3281b84e32dc303f95f62a7a4203a Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 15:13:46 +0300 Subject: [PATCH 10/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 33 ++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index ec2f14ce7e8a9..199c5144f91fa 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -77,20 +77,41 @@ new eks.Cluster(this, 'HelloEKS', { }); ``` -This will provision an Amazon EKS cluster with the following configuration: - -- Managed Node Group with 2 **m5.large** instances (this instance type suits most common use-cases, and is good value for money) -- Dedicated VPC with [default configuration](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc). +You can also use `eks.FargateCluster` to provision a managed cluster that uses fargate workers. -There are various way to customize the cluster capacity, i.e, the amount and type of worker nodes in the cluster. +```typescript +new eks.FargateCluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, +}); +``` -You can also use `eks.FargateCluster` to provision a managed cluster that uses fargate workers. +There are various ways to customize to cluster. The first important concept to understand is **capacity**. ### Capacity +Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity: #### Managed Node Groups +Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. +With Amazon EKS managed node groups, you don’t need to separately provision or register the Amazon EC2 instances that provide compute capacity to run your Kubernetes applications. You can create, update, or terminate nodes for your cluster with a single operation. Nodes run using the latest Amazon EKS optimized AMIs in your AWS account while node updates and terminations gracefully drain nodes to ensure that your applications stay available. + +> For more details: [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) + +Managed Node Groups are the recommended way to allocate cluster capacity. By default, this library will allocate a managed node group with 2 **m5.large** instances (this instance type suits most common use-cases, and is good value for money). + +At cluster instatiation time, you can customize the number of instances and their type: + +```typescript +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + defaultCapacity: 5, + defaultCapacityInstance: ec2.InstanceType.of(ec2.InstanceClass.M5, ec2.InstanceSize.SMALL), +}); +``` + + + #### Fargate Profiles #### Self Managed Auto Scaling Groups From d5aa7e490d07b265259bd0d4e1265ea52cc1e769 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 16:36:42 +0300 Subject: [PATCH 11/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 65 ++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 4 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index 199c5144f91fa..965cfc2435488 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -91,12 +91,12 @@ There are various ways to customize to cluster. The first important concept to u Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity: -#### Managed Node Groups +#### 1) Managed Node Groups Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. With Amazon EKS managed node groups, you don’t need to separately provision or register the Amazon EC2 instances that provide compute capacity to run your Kubernetes applications. You can create, update, or terminate nodes for your cluster with a single operation. Nodes run using the latest Amazon EKS optimized AMIs in your AWS account while node updates and terminations gracefully drain nodes to ensure that your applications stay available. -> For more details: [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) +> For more details visit [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). Managed Node Groups are the recommended way to allocate cluster capacity. By default, this library will allocate a managed node group with 2 **m5.large** instances (this instance type suits most common use-cases, and is good value for money). @@ -110,11 +110,68 @@ new eks.Cluster(this, 'HelloEKS', { }); ``` +Additional customizations are available post instatiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroup` method: +```typescript +const cluster = new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + defaultCapacity: 0, +}); + +cluster.addNodegroupCapacity('custom-node-group', { + instanceType: new ec2.InstanceType('m5.large'), + minSize: 4, + diskSize: 100, + amiType: eks.NodegroupAmiType.AL2_X86_64_GPU, + ... +}); +``` + +> For a complete API reference visit [`NodegroupOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupOptions.html) + +You can also directly use the `eks.Nodegroup` construct to create node groups under different scopes: + +```typescript +new eks.Nodegroup(scope, 'NodeGroup', { + cluster: cluster, + ... +}); +``` + +> For a complete API reference visit [`NodegroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupProps.html) + +##### Launch Template Support + +You can specify a launch template that the node group will use.. Note that when using a custom AMI, Amazon EKS doesn't merge any user data. +Rather, You are responsible for supplying the required bootstrap commands for nodes to join the cluster. +In the following example, `/ect/eks/bootstrap.sh` from the AMI will be used to bootstrap the node. + +```ts +const userData = ec2.UserData.forLinux(); +userData.addCommands( + 'set -o xtrace', + `/etc/eks/bootstrap.sh ${cluster.clusterName}`, +); +const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { + launchTemplateData: { + imageId: 'some-ami-id', // custom AMI + instanceType: new ec2.InstanceType('t3.small').toString(), + userData: Fn.base64(userData.render()), + }, +}); +cluster.addNodegroupCapacity('extra-ng', { + launchTemplateSpec: { + id: lt.ref, + version: lt.attrDefaultVersionNumber, + }, +}); +``` + +> For more details visit [Using a custom AMI](https://docs.aws.amazon.com/en_ca/eks/latest/userguide/launch-templates.html). -#### Fargate Profiles +#### 2) Fargate Profiles -#### Self Managed Auto Scaling Groups +#### 3) Self Managed Auto Scaling Groups From 9bbc1bcf044a47b823251ca22425475538fa4fa7 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 19:19:35 +0300 Subject: [PATCH 12/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 20 ++++--- packages/@aws-cdk/aws-eks/README.md | 84 ----------------------------- 2 files changed, 12 insertions(+), 92 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index 965cfc2435488..6b9313ea3239e 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -20,9 +20,9 @@ In addition, the library also supports defining Kubernetes resource manifests wi * [Overview](#overview) * [Provisioning clusters](#provisioning-clusters) * [Capacity](#capacity) - * [Managed Node Groups](#managed-node-groups) - * [Fargate Profiles](#fargate-profiles) - * [Self Managed Auto Scaling Groups](#self-managed-auto-scaling-groups) + * [Managed Node Groups](#1-managed-node-groups) + * [Fargate Profiles](#2-fargate-profiles) + * [Self Managed Auto Scaling Groups](#3-self-managed-auto-scaling-groups) * [VPC Support](#vpc-support) * [Endpoint Access](#endpoint-access) * [Permissions](#permissions) @@ -85,6 +85,8 @@ new eks.FargateCluster(this, 'HelloEKS', { }); ``` +> **NOTE: You can only create 1 cluster per stack.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see https://github.com/aws/aws-cdk/issues/10073. + There are various ways to customize to cluster. The first important concept to understand is **capacity**. ### Capacity @@ -98,7 +100,9 @@ With Amazon EKS managed node groups, you don’t need to separately provision or > For more details visit [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). -Managed Node Groups are the recommended way to allocate cluster capacity. By default, this library will allocate a managed node group with 2 **m5.large** instances (this instance type suits most common use-cases, and is good value for money). +**Managed Node Groups are the recommended way to allocate cluster capacity.** + +By default, this library will allocate a managed node group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). At cluster instatiation time, you can customize the number of instances and their type: @@ -110,7 +114,7 @@ new eks.Cluster(this, 'HelloEKS', { }); ``` -Additional customizations are available post instatiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroup` method: +Additional customizations are available post instatiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroupCapacity` method: ```typescript const cluster = new eks.Cluster(this, 'HelloEKS', { @@ -127,7 +131,7 @@ cluster.addNodegroupCapacity('custom-node-group', { }); ``` -> For a complete API reference visit [`NodegroupOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupOptions.html) +> For a complete API reference visit [`NodegroupOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupOptions.html). You can also directly use the `eks.Nodegroup` construct to create node groups under different scopes: @@ -138,7 +142,7 @@ new eks.Nodegroup(scope, 'NodeGroup', { }); ``` -> For a complete API reference visit [`NodegroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupProps.html) +> For a complete API reference visit [`NodegroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupProps.html). ##### Launch Template Support @@ -167,7 +171,7 @@ cluster.addNodegroupCapacity('extra-ng', { }); ``` -> For more details visit [Using a custom AMI](https://docs.aws.amazon.com/en_ca/eks/latest/userguide/launch-templates.html). +> For more details visit [Launch Template Support](https://docs.aws.amazon.com/en_ca/eks/latest/userguide/launch-templates.html). #### 2) Fargate Profiles diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index aebdd8c4c75a9..a02e30e6e075b 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -1,27 +1,5 @@ -## Amazon EKS Construct Library - ---- - -![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) - -> All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use. - -![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.svg?style=for-the-badge) - -> The APIs of higher level constructs in this module are in **developer preview** before they become stable. We will only make breaking changes to address unforeseen API issues. Therefore, these APIs are not subject to [Semantic Versioning](https://semver.org/), and breaking changes will be announced in release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package. - ---- - - - -This construct library allows you to define [Amazon Elastic Container Service -for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters programmatically. -This library also supports programmatically defining Kubernetes resource -manifests within EKS clusters. - This example defines an Amazon EKS cluster with the following configuration: -- Managed nodegroup with 2x **m5.large** instances (this instance type suits most common use-cases, and is good value for money) - Dedicated VPC with default configuration (see [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) - A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. @@ -47,8 +25,6 @@ cluster.addManifest('mypod', { }); ``` -> **NOTE: You can only create 1 cluster per stack.** If you have a use-case for multiple clusters per stack, > or would like to understand more about this limitation, see https://github.com/aws/aws-cdk/issues/10073. - In order to interact with your cluster through `kubectl`, you can use the `aws eks update-kubeconfig` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) to configure your local kubeconfig. @@ -89,20 +65,6 @@ pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m ... ``` -### Endpoint Access - -You can configure the [cluster endpoint access](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) by using the `endpointAccess` property: - -```typescript -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_16, - endpointAccess: eks.EndpointAccess.PRIVATE // No access outside of your VPC. -}); -``` - -The default value is `eks.EndpointAccess.PUBLIC_AND_PRIVATE`. Which means the cluster endpoint is accessible from outside of your VPC, but worker node traffic as well as `kubectl` commands -to the endpoint will stay within your VPC. - ### Capacity By default, `eks.Cluster` is created with a managed nodegroup with x2 `m5.large` instances. You must specify the kubernetes version for the cluster with the `version` property. @@ -157,52 +119,6 @@ cluster.addAutoScalingGroupCapacity('frontend-nodes', { }); ``` -### Managed Node Groups - -Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) -for Amazon EKS Kubernetes clusters. By default, `eks.Nodegroup` create a nodegroup with x2 `t3.medium` instances. - -```ts -new eks.Nodegroup(stack, 'nodegroup', { cluster }); -``` - -You can add customized node groups through `cluster.addNodegroup()`: - -```ts -cluster.addNodegroup('nodegroup', { - instanceType: new ec2.InstanceType('m5.large'), - minSize: 4, -}); -``` - -#### Custom AMI and Launch Template support - -Specify the launch template for the nodegroup with your custom AMI. When using a custom AMI, -Amazon EKS doesn't merge any user data. Rather, You are responsible for supplying the required -bootstrap commands for nodes to join the cluster. In the following sample, `/ect/eks/bootstrap.sh` from the AMI will be used to bootstrap the node. See [Using a custom AMI](https://docs.aws.amazon.com/en_ca/eks/latest/userguide/launch-templates.html) for more details. - -```ts -const userData = ec2.UserData.forLinux(); -userData.addCommands( - 'set -o xtrace', - `/etc/eks/bootstrap.sh ${this.cluster.clusterName}`, -); -const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { - launchTemplateData: { - // specify your custom AMI below - imageId, - instanceType: new ec2.InstanceType('t3.small').toString(), - userData: Fn.base64(userData.render()), - }, -}); -this.cluster.addNodegroup('extra-ng', { - launchTemplateSpec: { - id: lt.ref, - version: lt.attrDefaultVersionNumber, - }, -}); -``` - ### ARM64 Support Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest From dc1770d4abe6a49166655cccf567913e87dd6ea8 Mon Sep 17 00:00:00 2001 From: epolon Date: Sun, 27 Sep 2020 20:58:20 +0300 Subject: [PATCH 13/36] mid work --- yarn.lock | 692 ++---------------------------------------------------- 1 file changed, 14 insertions(+), 678 deletions(-) diff --git a/yarn.lock b/yarn.lock index 12f802c79983d..074fb6bae06ee 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1084,17 +1084,6 @@ resolved "https://registry.yarnpkg.com/@istanbuljs/schema/-/schema-0.1.2.tgz#26520bf09abe4a5644cd5414e37125a8954241dd" integrity sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw== -"@jest/console@^25.5.0": - version "25.5.0" - resolved "https://registry.yarnpkg.com/@jest/console/-/console-25.5.0.tgz#770800799d510f37329c508a9edd0b7b447d9abb" - integrity sha512-T48kZa6MK1Y6k4b89sexwmSF4YLeZS/Udqg3Jj3jG/cHH+N/sLFCEoXEDMOKugJQ9FxPN1osxIknvKkxt6MKyw== - dependencies: - "@jest/types" "^25.5.0" - chalk "^3.0.0" - jest-message-util "^25.5.0" - jest-util "^25.5.0" - slash "^3.0.0" - "@jest/console@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/console/-/console-26.3.0.tgz#ed04063efb280c88ba87388b6f16427c0a85c856" @@ -1107,40 +1096,6 @@ jest-util "^26.3.0" slash "^3.0.0" -"@jest/core@^25.5.4": - version "25.5.4" - resolved "https://registry.yarnpkg.com/@jest/core/-/core-25.5.4.tgz#3ef7412f7339210f003cdf36646bbca786efe7b4" - integrity sha512-3uSo7laYxF00Dg/DMgbn4xMJKmDdWvZnf89n8Xj/5/AeQ2dOQmn6b6Hkj/MleyzZWXpwv+WSdYWl4cLsy2JsoA== - dependencies: - "@jest/console" "^25.5.0" - "@jest/reporters" "^25.5.1" - "@jest/test-result" "^25.5.0" - "@jest/transform" "^25.5.1" - "@jest/types" "^25.5.0" - ansi-escapes "^4.2.1" - chalk "^3.0.0" - exit "^0.1.2" - graceful-fs "^4.2.4" - jest-changed-files "^25.5.0" - jest-config "^25.5.4" - jest-haste-map "^25.5.1" - jest-message-util "^25.5.0" - jest-regex-util "^25.2.6" - jest-resolve "^25.5.1" - jest-resolve-dependencies "^25.5.4" - jest-runner "^25.5.4" - jest-runtime "^25.5.4" - jest-snapshot "^25.5.1" - jest-util "^25.5.0" - jest-validate "^25.5.0" - jest-watcher "^25.5.0" - micromatch "^4.0.2" - p-each-series "^2.1.0" - realpath-native "^2.0.0" - rimraf "^3.0.0" - slash "^3.0.0" - strip-ansi "^6.0.0" - "@jest/core@^26.4.2": version "26.4.2" resolved "https://registry.yarnpkg.com/@jest/core/-/core-26.4.2.tgz#85d0894f31ac29b5bab07aa86806d03dd3d33edc" @@ -1175,15 +1130,6 @@ slash "^3.0.0" strip-ansi "^6.0.0" -"@jest/environment@^25.5.0": - version "25.5.0" - resolved "https://registry.yarnpkg.com/@jest/environment/-/environment-25.5.0.tgz#aa33b0c21a716c65686638e7ef816c0e3a0c7b37" - integrity sha512-U2VXPEqL07E/V7pSZMSQCvV5Ea4lqOlT+0ZFijl/i316cRMHvZ4qC+jBdryd+lmRetjQo0YIQr6cVPNxxK87mA== - dependencies: - "@jest/fake-timers" "^25.5.0" - "@jest/types" "^25.5.0" - jest-mock "^25.5.0" - "@jest/environment@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/environment/-/environment-26.3.0.tgz#e6953ab711ae3e44754a025f838bde1a7fd236a0" @@ -1194,17 +1140,6 @@ "@types/node" "*" jest-mock "^26.3.0" -"@jest/fake-timers@^25.5.0": - version "25.5.0" - resolved "https://registry.yarnpkg.com/@jest/fake-timers/-/fake-timers-25.5.0.tgz#46352e00533c024c90c2bc2ad9f2959f7f114185" - integrity sha512-9y2+uGnESw/oyOI3eww9yaxdZyHq7XvprfP/eeoCsjqKYts2yRlsHS/SgjPDV8FyMfn2nbMy8YzUk6nyvdLOpQ== - dependencies: - "@jest/types" "^25.5.0" - jest-message-util "^25.5.0" - jest-mock "^25.5.0" - jest-util "^25.5.0" - lolex "^5.0.0" - "@jest/fake-timers@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/fake-timers/-/fake-timers-26.3.0.tgz#f515d4667a6770f60ae06ae050f4e001126c666a" @@ -1217,15 +1152,6 @@ jest-mock "^26.3.0" jest-util "^26.3.0" -"@jest/globals@^25.5.2": - version "25.5.2" - resolved "https://registry.yarnpkg.com/@jest/globals/-/globals-25.5.2.tgz#5e45e9de8d228716af3257eeb3991cc2e162ca88" - integrity sha512-AgAS/Ny7Q2RCIj5kZ+0MuKM1wbF0WMLxbCVl/GOMoCNbODRdJ541IxJ98xnZdVSZXivKpJlNPIWa3QmY0l4CXA== - dependencies: - "@jest/environment" "^25.5.0" - "@jest/types" "^25.5.0" - expect "^25.5.0" - "@jest/globals@^26.4.2": version "26.4.2" resolved "https://registry.yarnpkg.com/@jest/globals/-/globals-26.4.2.tgz#73c2a862ac691d998889a241beb3dc9cada40d4a" @@ -1235,38 +1161,6 @@ "@jest/types" "^26.3.0" expect "^26.4.2" -"@jest/reporters@^25.5.1": - version "25.5.1" - resolved "https://registry.yarnpkg.com/@jest/reporters/-/reporters-25.5.1.tgz#cb686bcc680f664c2dbaf7ed873e93aa6811538b" - integrity sha512-3jbd8pPDTuhYJ7vqiHXbSwTJQNavczPs+f1kRprRDxETeE3u6srJ+f0NPuwvOmk+lmunZzPkYWIFZDLHQPkviw== - dependencies: - "@bcoe/v8-coverage" "^0.2.3" - "@jest/console" "^25.5.0" - "@jest/test-result" "^25.5.0" - "@jest/transform" "^25.5.1" - "@jest/types" "^25.5.0" - chalk "^3.0.0" - collect-v8-coverage "^1.0.0" - exit "^0.1.2" - glob "^7.1.2" - graceful-fs "^4.2.4" - istanbul-lib-coverage "^3.0.0" - istanbul-lib-instrument "^4.0.0" - istanbul-lib-report "^3.0.0" - istanbul-lib-source-maps "^4.0.0" - istanbul-reports "^3.0.2" - jest-haste-map "^25.5.1" - jest-resolve "^25.5.1" - jest-util "^25.5.0" - jest-worker "^25.5.0" - slash "^3.0.0" - source-map "^0.6.0" - string-length "^3.1.0" - terminal-link "^2.0.0" - v8-to-istanbul "^4.1.3" - optionalDependencies: - node-notifier "^6.0.0" - "@jest/reporters@^26.4.1": version "26.4.1" resolved "https://registry.yarnpkg.com/@jest/reporters/-/reporters-26.4.1.tgz#3b4d6faf28650f3965f8b97bc3d114077fb71795" @@ -1299,15 +1193,6 @@ optionalDependencies: node-notifier "^8.0.0" -"@jest/source-map@^25.5.0": - version "25.5.0" - resolved "https://registry.yarnpkg.com/@jest/source-map/-/source-map-25.5.0.tgz#df5c20d6050aa292c2c6d3f0d2c7606af315bd1b" - integrity sha512-eIGx0xN12yVpMcPaVpjXPnn3N30QGJCJQSkEDUt9x1fI1Gdvb07Ml6K5iN2hG7NmMP6FDmtPEssE3z6doOYUwQ== - dependencies: - callsites "^3.0.0" - graceful-fs "^4.2.4" - source-map "^0.6.0" - "@jest/source-map@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/source-map/-/source-map-26.3.0.tgz#0e646e519883c14c551f7b5ae4ff5f1bfe4fc3d9" @@ -1317,16 +1202,6 @@ graceful-fs "^4.2.4" source-map "^0.6.0" -"@jest/test-result@^25.5.0": - version "25.5.0" - resolved "https://registry.yarnpkg.com/@jest/test-result/-/test-result-25.5.0.tgz#139a043230cdeffe9ba2d8341b27f2efc77ce87c" - integrity sha512-oV+hPJgXN7IQf/fHWkcS99y0smKLU2czLBJ9WA0jHITLst58HpQMtzSYxzaBvYc6U5U6jfoMthqsUlUlbRXs0A== - dependencies: - "@jest/console" "^25.5.0" - "@jest/types" "^25.5.0" - "@types/istanbul-lib-coverage" "^2.0.0" - collect-v8-coverage "^1.0.0" - "@jest/test-result@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/test-result/-/test-result-26.3.0.tgz#46cde01fa10c0aaeb7431bf71e4a20d885bc7fdb" @@ -1337,17 +1212,6 @@ "@types/istanbul-lib-coverage" "^2.0.0" collect-v8-coverage "^1.0.0" -"@jest/test-sequencer@^25.5.4": - version "25.5.4" - resolved "https://registry.yarnpkg.com/@jest/test-sequencer/-/test-sequencer-25.5.4.tgz#9b4e685b36954c38d0f052e596d28161bdc8b737" - integrity sha512-pTJGEkSeg1EkCO2YWq6hbFvKNXk8ejqlxiOg1jBNLnWrgXOkdY6UmqZpwGFXNnRt9B8nO1uWMzLLZ4eCmhkPNA== - dependencies: - "@jest/test-result" "^25.5.0" - graceful-fs "^4.2.4" - jest-haste-map "^25.5.1" - jest-runner "^25.5.4" - jest-runtime "^25.5.4" - "@jest/test-sequencer@^26.4.2": version "26.4.2" resolved "https://registry.yarnpkg.com/@jest/test-sequencer/-/test-sequencer-26.4.2.tgz#58a3760a61eec758a2ce6080201424580d97cbba" @@ -1359,28 +1223,6 @@ jest-runner "^26.4.2" jest-runtime "^26.4.2" -"@jest/transform@^25.5.1": - version "25.5.1" - resolved "https://registry.yarnpkg.com/@jest/transform/-/transform-25.5.1.tgz#0469ddc17699dd2bf985db55fa0fb9309f5c2db3" - integrity sha512-Y8CEoVwXb4QwA6Y/9uDkn0Xfz0finGkieuV0xkdF9UtZGJeLukD5nLkaVrVsODB1ojRWlaoD0AJZpVHCSnJEvg== - dependencies: - "@babel/core" "^7.1.0" - "@jest/types" "^25.5.0" - babel-plugin-istanbul "^6.0.0" - chalk "^3.0.0" - convert-source-map "^1.4.0" - fast-json-stable-stringify "^2.0.0" - graceful-fs "^4.2.4" - jest-haste-map "^25.5.1" - jest-regex-util "^25.2.6" - jest-util "^25.5.0" - micromatch "^4.0.2" - pirates "^4.0.1" - realpath-native "^2.0.0" - slash "^3.0.0" - source-map "^0.6.1" - write-file-atomic "^3.0.0" - "@jest/transform@^26.3.0": version "26.3.0" resolved "https://registry.yarnpkg.com/@jest/transform/-/transform-26.3.0.tgz#c393e0e01459da8a8bfc6d2a7c2ece1a13e8ba55" @@ -3151,7 +2993,7 @@ jest-diff "^25.2.1" pretty-format "^25.2.1" -"@types/jest@^26.0.10", "@types/jest@^26.0.14": +"@types/jest@^26.0.14": version "26.0.14" resolved "https://registry.yarnpkg.com/@types/jest/-/jest-26.0.14.tgz#078695f8f65cb55c5a98450d65083b2b73e5a3f3" integrity sha512-Hz5q8Vu0D288x3iWXePSn53W7hAjP0H7EQ6QvDO9c7t46mR0lNOLlfuwQ+JkVxuhygHzlzPX+0jKdA3ZgSh+Vg== @@ -3240,11 +3082,6 @@ resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0" integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA== -"@types/prettier@^1.19.0": - version "1.19.1" - resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-1.19.1.tgz#33509849f8e679e4add158959fdb086440e9553f" - integrity sha512-5qOlnZscTn4xxM5MeGXAMOsIOIKIbh9e85zJWfBRVPlRMEVawzoPhINYbRGkBZCI8LxvBe7tJCdWiarA99OZfQ== - "@types/prettier@^2.0.0": version "2.0.2" resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.0.2.tgz#5bb52ee68d0f8efa9cc0099920e56be6cc4e37f3" @@ -3449,7 +3286,7 @@ abortcontroller-polyfill@^1.1.9: resolved "https://registry.yarnpkg.com/abortcontroller-polyfill/-/abortcontroller-polyfill-1.5.0.tgz#2c562f530869abbcf88d949a2b60d1d402e87a7c" integrity sha512-O6Xk757Jb4o0LMzMOMdWvxpHWrQzruYBaUruFaIOfAQRnWFxfdXYobw12jrVHGtoXk6WiiyYzc0QWN9aL62HQA== -acorn-globals@^4.3.0, acorn-globals@^4.3.2: +acorn-globals@^4.3.0: version "4.3.4" resolved "https://registry.yarnpkg.com/acorn-globals/-/acorn-globals-4.3.4.tgz#9fa1926addc11c97308c4e66d7add0d40c3272e7" integrity sha512-clfQEh21R+D0leSbUdWf3OcfqyaCSAQ8Ryq00bofSekfr9W8u1jyYZo6ir0xu9Gtcf7BjcHJpnbZH7JOCpP60A== @@ -3485,7 +3322,7 @@ acorn@^6.0.1, acorn@^6.0.4: resolved "https://registry.yarnpkg.com/acorn/-/acorn-6.4.1.tgz#531e58ba3f51b9dacb9a6646ca4debf5b14ca474" integrity sha512-ZVA9k326Nwrj3Cj9jlh3wGFutC2ZornPNARZwsNYqQYgN0EsV2d53w5RN/co65Ohn4sUAUtb1rSUAOD6XN9idA== -acorn@^7.1.0, acorn@^7.1.1, acorn@^7.4.0: +acorn@^7.1.1, acorn@^7.4.0: version "7.4.0" resolved "https://registry.yarnpkg.com/acorn/-/acorn-7.4.0.tgz#e1ad486e6c54501634c6c397c5c121daa383607c" integrity sha512-+G7P8jJmCHr+S+cLfQxygbWhXy+8YTVGzAkpEbcLo2mLoL7tij/VG41QSHACSf5QgYRhMZYHuNc6drJaO0Da+w== @@ -3951,20 +3788,6 @@ axios@^0.19.0: dependencies: follow-redirects "1.5.10" -babel-jest@^25.5.1: - version "25.5.1" - resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-25.5.1.tgz#bc2e6101f849d6f6aec09720ffc7bc5332e62853" - integrity sha512-9dA9+GmMjIzgPnYtkhBg73gOo/RHqPmLruP3BaGL4KEX3Dwz6pI8auSN8G8+iuEG90+GSswyKvslN+JYSaacaQ== - dependencies: - "@jest/transform" "^25.5.1" - "@jest/types" "^25.5.0" - "@types/babel__core" "^7.1.7" - babel-plugin-istanbul "^6.0.0" - babel-preset-jest "^25.5.0" - chalk "^3.0.0" - graceful-fs "^4.2.4" - slash "^3.0.0" - babel-jest@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-26.3.0.tgz#10d0ca4b529ca3e7d1417855ef7d7bd6fc0c3463" @@ -3997,15 +3820,6 @@ babel-plugin-istanbul@^6.0.0: istanbul-lib-instrument "^4.0.0" test-exclude "^6.0.0" -babel-plugin-jest-hoist@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-25.5.0.tgz#129c80ba5c7fc75baf3a45b93e2e372d57ca2677" - integrity sha512-u+/W+WAjMlvoocYGTwthAiQSxDcJAyHpQ6oWlHdFZaaN+Rlk8Q7iiwDPg2lN/FyJtAYnKjFxbn7xus4HCFkg5g== - dependencies: - "@babel/template" "^7.3.3" - "@babel/types" "^7.3.3" - "@types/babel__traverse" "^7.0.6" - babel-plugin-jest-hoist@^26.2.0: version "26.2.0" resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-26.2.0.tgz#bdd0011df0d3d513e5e95f76bd53b51147aca2dd" @@ -4016,7 +3830,7 @@ babel-plugin-jest-hoist@^26.2.0: "@types/babel__core" "^7.0.0" "@types/babel__traverse" "^7.0.6" -babel-preset-current-node-syntax@^0.1.2, babel-preset-current-node-syntax@^0.1.3: +babel-preset-current-node-syntax@^0.1.3: version "0.1.3" resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-0.1.3.tgz#b4b547acddbf963cba555ba9f9cbbb70bfd044da" integrity sha512-uyexu1sVwcdFnyq9o8UQYsXwXflIh8LvrF5+cKrYam93ned1CStffB3+BEcsxGSgagoA3GEyjDqO4a/58hyPYQ== @@ -4033,14 +3847,6 @@ babel-preset-current-node-syntax@^0.1.2, babel-preset-current-node-syntax@^0.1.3 "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" "@babel/plugin-syntax-optional-chaining" "^7.8.3" -babel-preset-jest@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-25.5.0.tgz#c1d7f191829487a907764c65307faa0e66590b49" - integrity sha512-8ZczygctQkBU+63DtSOKGh7tFL0CeCuz+1ieud9lJ1WPQ9O6A1a/r+LGn6Y705PA6whHQ3T1XuB/PmpfNYf8Fw== - dependencies: - babel-plugin-jest-hoist "^25.5.0" - babel-preset-current-node-syntax "^0.1.2" - babel-preset-jest@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-26.3.0.tgz#ed6344506225c065fd8a0b53e191986f74890776" @@ -4159,13 +3965,6 @@ browser-process-hrtime@^1.0.0: resolved "https://registry.yarnpkg.com/browser-process-hrtime/-/browser-process-hrtime-1.0.0.tgz#3c9b4b7d782c8121e56f10106d84c0d0ffc94626" integrity sha512-9o5UecI3GhkpM6DrXr69PblIuWxPKk9Y0jHBRhdocZ2y7YECBFCsHm79Pr3OyR2AvjhDkabFJaDJMYRazHgsow== -browser-resolve@^1.11.3: - version "1.11.3" - resolved "https://registry.yarnpkg.com/browser-resolve/-/browser-resolve-1.11.3.tgz#9b7cbb3d0f510e4cb86bdbd796124d28b5890af6" - integrity sha512-exDi1BYWB/6raKHmDTCicQfTkqwN5fioMFV4j8BsfMU4R2DK/QfZfK7kOVkmWCNANf0snkBzqGqAJBao9gZMdQ== - dependencies: - resolve "1.1.7" - browserify-aes@^1.0.0, browserify-aes@^1.0.4: version "1.2.0" resolved "https://registry.yarnpkg.com/browserify-aes/-/browserify-aes-1.2.0.tgz#326734642f403dabc3003209853bb70ad428ef48" @@ -4481,15 +4280,6 @@ caseless@~0.12.0: resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc" integrity sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw= -cdk8s@^0.29.0: - version "0.29.0" - resolved "https://registry.yarnpkg.com/cdk8s/-/cdk8s-0.29.0.tgz#3bf7861aef22c6401e5800a3c5b4d680f31d3eeb" - integrity sha512-MV/6qzdSqLjDRW1dEE2tCtgp4OxirqbagY04JOhW7z8rnveQA9p24iWXkupf4uebs3SmBuVVeDgupuH/MZZX8w== - dependencies: - follow-redirects "^1.11.0" - json-stable-stringify "^1.0.1" - yaml "^1.7.2" - chalk@^1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98" @@ -5453,7 +5243,7 @@ cssom@0.3.x, cssom@^0.3.4, cssom@~0.3.6: resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.3.8.tgz#9f1276f5b2b463f2114d3f2c75250af8c1a36f4a" integrity sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg== -cssom@^0.4.1, cssom@^0.4.4: +cssom@^0.4.4: version "0.4.4" resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.4.4.tgz#5a66cf93d2d0b661d80bf6a44fb65f5c2e4e0a10" integrity sha512-p3pvU7r1MyyqbTk+WbNJIgJjG2VmTIaB10rI93LzVPrmDJKkzKYMtxxyAvQXR/NS6otuzveI7+7BBq3SjBS2mw== @@ -5465,7 +5255,7 @@ cssstyle@^1.1.1: dependencies: cssom "0.3.x" -cssstyle@^2.0.0, cssstyle@^2.2.0: +cssstyle@^2.2.0: version "2.3.0" resolved "https://registry.yarnpkg.com/cssstyle/-/cssstyle-2.3.0.tgz#ff665a0ddbdc31864b09647f34163443d90b0852" integrity sha512-AZL67abkUzIuvcHqk7c09cezpGNcxUxU4Ioi/05xHk4DQeTkWmGYftIE6ctU6AEt+Gn4n1lDStOtj7FKycP71A== @@ -6160,7 +5950,7 @@ escape-string-regexp@^4.0.0: resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== -escodegen@1.x.x, escodegen@^1.11.0, escodegen@^1.11.1, escodegen@^1.14.1: +escodegen@1.x.x, escodegen@^1.11.0, escodegen@^1.14.1: version "1.14.3" resolved "https://registry.yarnpkg.com/escodegen/-/escodegen-1.14.3.tgz#4e7b81fba61581dc97582ed78cab7f0e8d63f503" integrity sha512-qFcX0XJkdg+PB3xjZZG/wKSuT1PnQWx57+TVSjIMmILd2yC/6ByYElPwJnslDsuWuSAp4AwJGumarAAmJch5Kw== @@ -6440,22 +6230,6 @@ execa@^1.0.0: signal-exit "^3.0.0" strip-eof "^1.0.0" -execa@^3.2.0: - version "3.4.0" - resolved "https://registry.yarnpkg.com/execa/-/execa-3.4.0.tgz#c08ed4550ef65d858fac269ffc8572446f37eb89" - integrity sha512-r9vdGQk4bmCuK1yKQu1KTwcT2zwfWdbdaXfCtAh+5nU/4fSX+JAb7vZGvI5naJrQlvONrEB20jeruESI69530g== - dependencies: - cross-spawn "^7.0.0" - get-stream "^5.0.0" - human-signals "^1.1.1" - is-stream "^2.0.0" - merge-stream "^2.0.0" - npm-run-path "^4.0.0" - onetime "^5.1.0" - p-finally "^2.0.0" - signal-exit "^3.0.2" - strip-final-newline "^2.0.0" - execa@^4.0.0, execa@^4.0.3: version "4.0.3" resolved "https://registry.yarnpkg.com/execa/-/execa-4.0.3.tgz#0a34dabbad6d66100bd6f2c576c8669403f317f2" @@ -6489,18 +6263,6 @@ expand-brackets@^2.1.4: snapdragon "^0.8.1" to-regex "^3.0.1" -expect@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/expect/-/expect-25.5.0.tgz#f07f848712a2813bb59167da3fb828ca21f58bba" - integrity sha512-w7KAXo0+6qqZZhovCaBVPSIqQp7/UTcx4M9uKt2m6pd2VB1voyC8JizLRqeEqud3AAVP02g+hbErDu5gu64tlA== - dependencies: - "@jest/types" "^25.5.0" - ansi-styles "^4.0.0" - jest-get-type "^25.2.6" - jest-matcher-utils "^25.5.0" - jest-message-util "^25.5.0" - jest-regex-util "^25.2.6" - expect@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/expect/-/expect-26.4.2.tgz#36db120928a5a2d7d9736643032de32f24e1b2a1" @@ -6817,7 +6579,7 @@ follow-redirects@1.5.10: dependencies: debug "=3.1.0" -follow-redirects@^1.0.0, follow-redirects@^1.11.0: +follow-redirects@^1.0.0: version "1.13.0" resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.13.0.tgz#b42e8d93a2a7eea5ed88633676d6597bc8e384db" integrity sha512-aq6gF1BEKje4a9i9+5jimNFIpq4Q1WiwBToeRK5NvZBd/TRsmW8BsJfOEGkr76TbOyPVD3OVDN910EcUNtRYEA== @@ -8260,15 +8022,6 @@ istanbul-reports@^3.0.2: html-escaper "^2.0.0" istanbul-lib-report "^3.0.0" -jest-changed-files@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-25.5.0.tgz#141cc23567ceb3f534526f8614ba39421383634c" - integrity sha512-EOw9QEqapsDT7mKF162m8HFzRPbmP8qJQny6ldVOdOVBz3ACgPm/1nAn5fPQ/NDaYhX/AHkrGwwkCncpAVSXcw== - dependencies: - "@jest/types" "^25.5.0" - execa "^3.2.0" - throat "^5.0.0" - jest-changed-files@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-26.3.0.tgz#68fb2a7eb125f50839dab1f5a17db3607fe195b1" @@ -8278,26 +8031,6 @@ jest-changed-files@^26.3.0: execa "^4.0.0" throat "^5.0.0" -jest-cli@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-25.5.4.tgz#b9f1a84d1301a92c5c217684cb79840831db9f0d" - integrity sha512-rG8uJkIiOUpnREh1768/N3n27Cm+xPFkSNFO91tgg+8o2rXeVLStz+vkXkGr4UtzH6t1SNbjwoiswd7p4AhHTw== - dependencies: - "@jest/core" "^25.5.4" - "@jest/test-result" "^25.5.0" - "@jest/types" "^25.5.0" - chalk "^3.0.0" - exit "^0.1.2" - graceful-fs "^4.2.4" - import-local "^3.0.2" - is-ci "^2.0.0" - jest-config "^25.5.4" - jest-util "^25.5.0" - jest-validate "^25.5.0" - prompts "^2.0.1" - realpath-native "^2.0.0" - yargs "^15.3.1" - jest-cli@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-26.4.2.tgz#24afc6e4dfc25cde4c7ec4226fb7db5f157c21da" @@ -8317,31 +8050,6 @@ jest-cli@^26.4.2: prompts "^2.0.1" yargs "^15.3.1" -jest-config@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-25.5.4.tgz#38e2057b3f976ef7309b2b2c8dcd2a708a67f02c" - integrity sha512-SZwR91SwcdK6bz7Gco8qL7YY2sx8tFJYzvg216DLihTWf+LKY/DoJXpM9nTzYakSyfblbqeU48p/p7Jzy05Atg== - dependencies: - "@babel/core" "^7.1.0" - "@jest/test-sequencer" "^25.5.4" - "@jest/types" "^25.5.0" - babel-jest "^25.5.1" - chalk "^3.0.0" - deepmerge "^4.2.2" - glob "^7.1.1" - graceful-fs "^4.2.4" - jest-environment-jsdom "^25.5.0" - jest-environment-node "^25.5.0" - jest-get-type "^25.2.6" - jest-jasmine2 "^25.5.4" - jest-regex-util "^25.2.6" - jest-resolve "^25.5.1" - jest-util "^25.5.0" - jest-validate "^25.5.0" - micromatch "^4.0.2" - pretty-format "^25.5.0" - realpath-native "^2.0.0" - jest-config@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-26.4.2.tgz#da0cbb7dc2c131ffe831f0f7f2a36256e6086558" @@ -8366,7 +8074,7 @@ jest-config@^26.4.2: micromatch "^4.0.2" pretty-format "^26.4.2" -jest-diff@^25.2.1, jest-diff@^25.5.0: +jest-diff@^25.2.1: version "25.5.0" resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-25.5.0.tgz#1dd26ed64f96667c068cef026b677dfa01afcfa9" integrity sha512-z1kygetuPiREYdNIumRpAHY6RXiGmp70YHptjdaxTWGmA085W3iCnXNx0DhflK3vwrKmrRWyY1wUpkPMVxMK7A== @@ -8386,13 +8094,6 @@ jest-diff@^26.4.2: jest-get-type "^26.3.0" pretty-format "^26.4.2" -jest-docblock@^25.3.0: - version "25.3.0" - resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-25.3.0.tgz#8b777a27e3477cd77a168c05290c471a575623ef" - integrity sha512-aktF0kCar8+zxRHxQZwxMy70stc9R1mOmrLsT5VO3pIT0uzGRSDAXxSlz4NqQWpuLjPpuMhPRl7H+5FRsvIQAg== - dependencies: - detect-newline "^3.0.0" - jest-docblock@^26.0.0: version "26.0.0" resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-26.0.0.tgz#3e2fa20899fc928cb13bd0ff68bd3711a36889b5" @@ -8400,17 +8101,6 @@ jest-docblock@^26.0.0: dependencies: detect-newline "^3.0.0" -jest-each@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-each/-/jest-each-25.5.0.tgz#0c3c2797e8225cb7bec7e4d249dcd96b934be516" - integrity sha512-QBogUxna3D8vtiItvn54xXde7+vuzqRrEeaw8r1s+1TG9eZLVJE5ZkKoSUlqFwRjnlaA4hyKGiu9OlkFIuKnjA== - dependencies: - "@jest/types" "^25.5.0" - chalk "^3.0.0" - jest-get-type "^25.2.6" - jest-util "^25.5.0" - pretty-format "^25.5.0" - jest-each@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-each/-/jest-each-26.4.2.tgz#bb14f7f4304f2bb2e2b81f783f989449b8b6ffae" @@ -8422,18 +8112,6 @@ jest-each@^26.4.2: jest-util "^26.3.0" pretty-format "^26.4.2" -jest-environment-jsdom@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-environment-jsdom/-/jest-environment-jsdom-25.5.0.tgz#dcbe4da2ea997707997040ecf6e2560aec4e9834" - integrity sha512-7Jr02ydaq4jaWMZLY+Skn8wL5nVIYpWvmeatOHL3tOcV3Zw8sjnPpx+ZdeBfc457p8jCR9J6YCc+Lga0oIy62A== - dependencies: - "@jest/environment" "^25.5.0" - "@jest/fake-timers" "^25.5.0" - "@jest/types" "^25.5.0" - jest-mock "^25.5.0" - jest-util "^25.5.0" - jsdom "^15.2.1" - jest-environment-jsdom@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-environment-jsdom/-/jest-environment-jsdom-26.3.0.tgz#3b749ba0f3a78e92ba2c9ce519e16e5dd515220c" @@ -8447,18 +8125,6 @@ jest-environment-jsdom@^26.3.0: jest-util "^26.3.0" jsdom "^16.2.2" -jest-environment-node@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-25.5.0.tgz#0f55270d94804902988e64adca37c6ce0f7d07a1" - integrity sha512-iuxK6rQR2En9EID+2k+IBs5fCFd919gVVK5BeND82fYeLWPqvRcFNPKu9+gxTwfB5XwBGBvZ0HFQa+cHtIoslA== - dependencies: - "@jest/environment" "^25.5.0" - "@jest/fake-timers" "^25.5.0" - "@jest/types" "^25.5.0" - jest-mock "^25.5.0" - jest-util "^25.5.0" - semver "^6.3.0" - jest-environment-node@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-26.3.0.tgz#56c6cfb506d1597f94ee8d717072bda7228df849" @@ -8481,26 +8147,6 @@ jest-get-type@^26.3.0: resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-26.3.0.tgz#e97dc3c3f53c2b406ca7afaed4493b1d099199e0" integrity sha512-TpfaviN1R2pQWkIihlfEanwOXK0zcxrKEE4MlU6Tn7keoXdN6/3gK/xl0yEh8DOunn5pOVGKf8hB4R9gVh04ig== -jest-haste-map@^25.5.1: - version "25.5.1" - resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-25.5.1.tgz#1df10f716c1d94e60a1ebf7798c9fb3da2620943" - integrity sha512-dddgh9UZjV7SCDQUrQ+5t9yy8iEgKc1AKqZR9YDww8xsVOtzPQSMVLDChc21+g29oTRexb9/B0bIlZL+sWmvAQ== - dependencies: - "@jest/types" "^25.5.0" - "@types/graceful-fs" "^4.1.2" - anymatch "^3.0.3" - fb-watchman "^2.0.0" - graceful-fs "^4.2.4" - jest-serializer "^25.5.0" - jest-util "^25.5.0" - jest-worker "^25.5.0" - micromatch "^4.0.2" - sane "^4.0.3" - walker "^1.0.7" - which "^2.0.2" - optionalDependencies: - fsevents "^2.1.2" - jest-haste-map@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-26.3.0.tgz#c51a3b40100d53ab777bfdad382d2e7a00e5c726" @@ -8522,29 +8168,6 @@ jest-haste-map@^26.3.0: optionalDependencies: fsevents "^2.1.2" -jest-jasmine2@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest-jasmine2/-/jest-jasmine2-25.5.4.tgz#66ca8b328fb1a3c5364816f8958f6970a8526968" - integrity sha512-9acbWEfbmS8UpdcfqnDO+uBUgKa/9hcRh983IHdM+pKmJPL77G0sWAAK0V0kr5LK3a8cSBfkFSoncXwQlRZfkQ== - dependencies: - "@babel/traverse" "^7.1.0" - "@jest/environment" "^25.5.0" - "@jest/source-map" "^25.5.0" - "@jest/test-result" "^25.5.0" - "@jest/types" "^25.5.0" - chalk "^3.0.0" - co "^4.6.0" - expect "^25.5.0" - is-generator-fn "^2.0.0" - jest-each "^25.5.0" - jest-matcher-utils "^25.5.0" - jest-message-util "^25.5.0" - jest-runtime "^25.5.4" - jest-snapshot "^25.5.1" - jest-util "^25.5.0" - pretty-format "^25.5.0" - throat "^5.0.0" - jest-jasmine2@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-jasmine2/-/jest-jasmine2-26.4.2.tgz#18a9d5bec30904267ac5e9797570932aec1e2257" @@ -8579,14 +8202,6 @@ jest-junit@^11.1.0: uuid "^3.3.3" xml "^1.0.1" -jest-leak-detector@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-25.5.0.tgz#2291c6294b0ce404241bb56fe60e2d0c3e34f0bb" - integrity sha512-rV7JdLsanS8OkdDpZtgBf61L5xZ4NnYLBq72r6ldxahJWWczZjXawRsoHyXzibM5ed7C2QRjpp6ypgwGdKyoVA== - dependencies: - jest-get-type "^25.2.6" - pretty-format "^25.5.0" - jest-leak-detector@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-26.4.2.tgz#c73e2fa8757bf905f6f66fb9e0070b70fa0f573f" @@ -8595,16 +8210,6 @@ jest-leak-detector@^26.4.2: jest-get-type "^26.3.0" pretty-format "^26.4.2" -jest-matcher-utils@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-25.5.0.tgz#fbc98a12d730e5d2453d7f1ed4a4d948e34b7867" - integrity sha512-VWI269+9JS5cpndnpCwm7dy7JtGQT30UHfrnM3mXl22gHGt/b7NkjBqXfbhZ8V4B7ANUsjK18PlSBmG0YH7gjw== - dependencies: - chalk "^3.0.0" - jest-diff "^25.5.0" - jest-get-type "^25.2.6" - pretty-format "^25.5.0" - jest-matcher-utils@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-26.4.2.tgz#fa81f3693f7cb67e5fc1537317525ef3b85f4b06" @@ -8615,20 +8220,6 @@ jest-matcher-utils@^26.4.2: jest-get-type "^26.3.0" pretty-format "^26.4.2" -jest-message-util@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-25.5.0.tgz#ea11d93204cc7ae97456e1d8716251185b8880ea" - integrity sha512-ezddz3YCT/LT0SKAmylVyWWIGYoKHOFOFXx3/nA4m794lfVUskMcwhip6vTgdVrOtYdjeQeis2ypzes9mZb4EA== - dependencies: - "@babel/code-frame" "^7.0.0" - "@jest/types" "^25.5.0" - "@types/stack-utils" "^1.0.1" - chalk "^3.0.0" - graceful-fs "^4.2.4" - micromatch "^4.0.2" - slash "^3.0.0" - stack-utils "^1.0.1" - jest-message-util@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-26.3.0.tgz#3bdb538af27bb417f2d4d16557606fd082d5841a" @@ -8643,13 +8234,6 @@ jest-message-util@^26.3.0: slash "^3.0.0" stack-utils "^2.0.2" -jest-mock@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-25.5.0.tgz#a91a54dabd14e37ecd61665d6b6e06360a55387a" - integrity sha512-eXWuTV8mKzp/ovHc5+3USJMYsTBhyQ+5A1Mak35dey/RG8GlM4YWVylZuGgVXinaW6tpvk/RSecmF37FKUlpXA== - dependencies: - "@jest/types" "^25.5.0" - jest-mock@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-26.3.0.tgz#ee62207c3c5ebe5f35b760e1267fee19a1cfdeba" @@ -8658,30 +8242,16 @@ jest-mock@^26.3.0: "@jest/types" "^26.3.0" "@types/node" "*" -jest-pnp-resolver@^1.2.1, jest-pnp-resolver@^1.2.2: +jest-pnp-resolver@^1.2.2: version "1.2.2" resolved "https://registry.yarnpkg.com/jest-pnp-resolver/-/jest-pnp-resolver-1.2.2.tgz#b704ac0ae028a89108a4d040b3f919dfddc8e33c" integrity sha512-olV41bKSMm8BdnuMsewT4jqlZ8+3TCARAXjZGT9jcoSnrfUnRCqnMoF9XEeoWjbzObpqF9dRhHQj0Xb9QdF6/w== -jest-regex-util@^25.2.6: - version "25.2.6" - resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-25.2.6.tgz#d847d38ba15d2118d3b06390056028d0f2fd3964" - integrity sha512-KQqf7a0NrtCkYmZZzodPftn7fL1cq3GQAFVMn5Hg8uKx/fIenLEobNanUxb7abQ1sjADHBseG/2FGpsv/wr+Qw== - jest-regex-util@^26.0.0: version "26.0.0" resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-26.0.0.tgz#d25e7184b36e39fd466c3bc41be0971e821fee28" integrity sha512-Gv3ZIs/nA48/Zvjrl34bf+oD76JHiGDUxNOVgUjh3j890sblXryjY4rss71fPtD/njchl6PSE2hIhvyWa1eT0A== -jest-resolve-dependencies@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-25.5.4.tgz#85501f53957c8e3be446e863a74777b5a17397a7" - integrity sha512-yFmbPd+DAQjJQg88HveObcGBA32nqNZ02fjYmtL16t1xw9bAttSn5UGRRhzMHIQbsep7znWvAvnD4kDqOFM0Uw== - dependencies: - "@jest/types" "^25.5.0" - jest-regex-util "^25.2.6" - jest-snapshot "^25.5.1" - jest-resolve-dependencies@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-26.4.2.tgz#739bdb027c14befb2fe5aabbd03f7bab355f1dc5" @@ -8691,21 +8261,6 @@ jest-resolve-dependencies@^26.4.2: jest-regex-util "^26.0.0" jest-snapshot "^26.4.2" -jest-resolve@^25.5.1: - version "25.5.1" - resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-25.5.1.tgz#0e6fbcfa7c26d2a5fe8f456088dc332a79266829" - integrity sha512-Hc09hYch5aWdtejsUZhA+vSzcotf7fajSlPA6EZPE1RmPBAD39XtJhvHWFStid58iit4IPDLI/Da4cwdDmAHiQ== - dependencies: - "@jest/types" "^25.5.0" - browser-resolve "^1.11.3" - chalk "^3.0.0" - graceful-fs "^4.2.4" - jest-pnp-resolver "^1.2.1" - read-pkg-up "^7.0.1" - realpath-native "^2.0.0" - resolve "^1.17.0" - slash "^3.0.0" - jest-resolve@^26.4.0: version "26.4.0" resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-26.4.0.tgz#6dc0af7fb93e65b73fec0368ca2b76f3eb59a6d7" @@ -8720,31 +8275,6 @@ jest-resolve@^26.4.0: resolve "^1.17.0" slash "^3.0.0" -jest-runner@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest-runner/-/jest-runner-25.5.4.tgz#ffec5df3875da5f5c878ae6d0a17b8e4ecd7c71d" - integrity sha512-V/2R7fKZo6blP8E9BL9vJ8aTU4TH2beuqGNxHbxi6t14XzTb+x90B3FRgdvuHm41GY8ch4xxvf0ATH4hdpjTqg== - dependencies: - "@jest/console" "^25.5.0" - "@jest/environment" "^25.5.0" - "@jest/test-result" "^25.5.0" - "@jest/types" "^25.5.0" - chalk "^3.0.0" - exit "^0.1.2" - graceful-fs "^4.2.4" - jest-config "^25.5.4" - jest-docblock "^25.3.0" - jest-haste-map "^25.5.1" - jest-jasmine2 "^25.5.4" - jest-leak-detector "^25.5.0" - jest-message-util "^25.5.0" - jest-resolve "^25.5.1" - jest-runtime "^25.5.4" - jest-util "^25.5.0" - jest-worker "^25.5.0" - source-map-support "^0.5.6" - throat "^5.0.0" - jest-runner@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-runner/-/jest-runner-26.4.2.tgz#c3ec5482c8edd31973bd3935df5a449a45b5b853" @@ -8771,38 +8301,6 @@ jest-runner@^26.4.2: source-map-support "^0.5.6" throat "^5.0.0" -jest-runtime@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-25.5.4.tgz#dc981fe2cb2137abcd319e74ccae7f7eeffbfaab" - integrity sha512-RWTt8LeWh3GvjYtASH2eezkc8AehVoWKK20udV6n3/gC87wlTbE1kIA+opCvNWyyPeBs6ptYsc6nyHUb1GlUVQ== - dependencies: - "@jest/console" "^25.5.0" - "@jest/environment" "^25.5.0" - "@jest/globals" "^25.5.2" - "@jest/source-map" "^25.5.0" - "@jest/test-result" "^25.5.0" - "@jest/transform" "^25.5.1" - "@jest/types" "^25.5.0" - "@types/yargs" "^15.0.0" - chalk "^3.0.0" - collect-v8-coverage "^1.0.0" - exit "^0.1.2" - glob "^7.1.3" - graceful-fs "^4.2.4" - jest-config "^25.5.4" - jest-haste-map "^25.5.1" - jest-message-util "^25.5.0" - jest-mock "^25.5.0" - jest-regex-util "^25.2.6" - jest-resolve "^25.5.1" - jest-snapshot "^25.5.1" - jest-util "^25.5.0" - jest-validate "^25.5.0" - realpath-native "^2.0.0" - slash "^3.0.0" - strip-bom "^4.0.0" - yargs "^15.3.1" - jest-runtime@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-26.4.2.tgz#94ce17890353c92e4206580c73a8f0c024c33c42" @@ -8835,13 +8333,6 @@ jest-runtime@^26.4.2: strip-bom "^4.0.0" yargs "^15.3.1" -jest-serializer@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-serializer/-/jest-serializer-25.5.0.tgz#a993f484e769b4ed54e70e0efdb74007f503072b" - integrity sha512-LxD8fY1lByomEPflwur9o4e2a5twSQ7TaVNLlFUuToIdoJuBt8tzHfCsZ42Ok6LkKXWzFWf3AGmheuLAA7LcCA== - dependencies: - graceful-fs "^4.2.4" - jest-serializer@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-serializer/-/jest-serializer-26.3.0.tgz#1c9d5e1b74d6e5f7e7f9627080fa205d976c33ef" @@ -8850,27 +8341,6 @@ jest-serializer@^26.3.0: "@types/node" "*" graceful-fs "^4.2.4" -jest-snapshot@^25.5.1: - version "25.5.1" - resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-25.5.1.tgz#1a2a576491f9961eb8d00c2e5fd479bc28e5ff7f" - integrity sha512-C02JE1TUe64p2v1auUJ2ze5vcuv32tkv9PyhEb318e8XOKF7MOyXdJ7kdjbvrp3ChPLU2usI7Rjxs97Dj5P0uQ== - dependencies: - "@babel/types" "^7.0.0" - "@jest/types" "^25.5.0" - "@types/prettier" "^1.19.0" - chalk "^3.0.0" - expect "^25.5.0" - graceful-fs "^4.2.4" - jest-diff "^25.5.0" - jest-get-type "^25.2.6" - jest-matcher-utils "^25.5.0" - jest-message-util "^25.5.0" - jest-resolve "^25.5.1" - make-dir "^3.0.0" - natural-compare "^1.4.0" - pretty-format "^25.5.0" - semver "^6.3.0" - jest-snapshot@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-26.4.2.tgz#87d3ac2f2bd87ea8003602fbebd8fcb9e94104f6" @@ -8904,29 +8374,6 @@ jest-util@26.x, jest-util@^26.3.0: is-ci "^2.0.0" micromatch "^4.0.2" -jest-util@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-25.5.0.tgz#31c63b5d6e901274d264a4fec849230aa3fa35b0" - integrity sha512-KVlX+WWg1zUTB9ktvhsg2PXZVdkI1NBevOJSkTKYAyXyH4QSvh+Lay/e/v+bmaFfrkfx43xD8QTfgobzlEXdIA== - dependencies: - "@jest/types" "^25.5.0" - chalk "^3.0.0" - graceful-fs "^4.2.4" - is-ci "^2.0.0" - make-dir "^3.0.0" - -jest-validate@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-25.5.0.tgz#fb4c93f332c2e4cf70151a628e58a35e459a413a" - integrity sha512-okUFKqhZIpo3jDdtUXUZ2LxGUZJIlfdYBvZb1aczzxrlyMlqdnnws9MOxezoLGhSaFc2XYaHNReNQfj5zPIWyQ== - dependencies: - "@jest/types" "^25.5.0" - camelcase "^5.3.1" - chalk "^3.0.0" - jest-get-type "^25.2.6" - leven "^3.1.0" - pretty-format "^25.5.0" - jest-validate@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-26.4.2.tgz#e871b0dfe97747133014dcf6445ee8018398f39c" @@ -8939,18 +8386,6 @@ jest-validate@^26.4.2: leven "^3.1.0" pretty-format "^26.4.2" -jest-watcher@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-watcher/-/jest-watcher-25.5.0.tgz#d6110d101df98badebe435003956fd4a465e8456" - integrity sha512-XrSfJnVASEl+5+bb51V0Q7WQx65dTSk7NL4yDdVjPnRNpM0hG+ncFmDYJo9O8jaSRcAitVbuVawyXCRoxGrT5Q== - dependencies: - "@jest/test-result" "^25.5.0" - "@jest/types" "^25.5.0" - ansi-escapes "^4.2.1" - chalk "^3.0.0" - jest-util "^25.5.0" - string-length "^3.1.0" - jest-watcher@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-watcher/-/jest-watcher-26.3.0.tgz#f8ef3068ddb8af160ef868400318dc4a898eed08" @@ -8964,14 +8399,6 @@ jest-watcher@^26.3.0: jest-util "^26.3.0" string-length "^4.0.1" -jest-worker@^25.5.0: - version "25.5.0" - resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-25.5.0.tgz#2611d071b79cea0f43ee57a3d118593ac1547db1" - integrity sha512-/dsSmUkIy5EBGfv/IjjqmFxrNAUpBERfGs1oHROyD7yxjG/w+t0GOJDX8O1k32ySmd7+a5IhnJU2qQFcJ4n1vw== - dependencies: - merge-stream "^2.0.0" - supports-color "^7.0.0" - jest-worker@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-26.3.0.tgz#7c8a97e4f4364b4f05ed8bca8ca0c24de091871f" @@ -8981,15 +8408,6 @@ jest-worker@^26.3.0: merge-stream "^2.0.0" supports-color "^7.0.0" -jest@^25.5.4: - version "25.5.4" - resolved "https://registry.yarnpkg.com/jest/-/jest-25.5.4.tgz#f21107b6489cfe32b076ce2adcadee3587acb9db" - integrity sha512-hHFJROBTqZahnO+X+PMtT6G2/ztqAZJveGqz//FnWWHurizkD05PQGzRZOhF3XP6z7SJmL+5tCfW8qV06JypwQ== - dependencies: - "@jest/core" "^25.5.4" - import-local "^3.0.2" - jest-cli "^25.5.4" - jest@^26.4.2: version "26.4.2" resolved "https://registry.yarnpkg.com/jest/-/jest-26.4.2.tgz#7e8bfb348ec33f5459adeaffc1a25d5752d9d312" @@ -9064,38 +8482,6 @@ jsdom@^14.1.0: ws "^6.1.2" xml-name-validator "^3.0.0" -jsdom@^15.2.1: - version "15.2.1" - resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-15.2.1.tgz#d2feb1aef7183f86be521b8c6833ff5296d07ec5" - integrity sha512-fAl1W0/7T2G5vURSyxBzrJ1LSdQn6Tr5UX/xD4PXDx/PDgwygedfW6El/KIj3xJ7FU61TTYnc/l/B7P49Eqt6g== - dependencies: - abab "^2.0.0" - acorn "^7.1.0" - acorn-globals "^4.3.2" - array-equal "^1.0.0" - cssom "^0.4.1" - cssstyle "^2.0.0" - data-urls "^1.1.0" - domexception "^1.0.1" - escodegen "^1.11.1" - html-encoding-sniffer "^1.0.2" - nwsapi "^2.2.0" - parse5 "5.1.0" - pn "^1.1.0" - request "^2.88.0" - request-promise-native "^1.0.7" - saxes "^3.1.9" - symbol-tree "^3.2.2" - tough-cookie "^3.0.1" - w3c-hr-time "^1.0.1" - w3c-xmlserializer "^1.1.2" - webidl-conversions "^4.0.2" - whatwg-encoding "^1.0.5" - whatwg-mimetype "^2.3.0" - whatwg-url "^7.0.0" - ws "^7.0.0" - xml-name-validator "^3.0.0" - jsdom@^16.2.2: version "16.4.0" resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-16.4.0.tgz#36005bde2d136f73eee1a830c6d45e55408edddb" @@ -9688,13 +9074,6 @@ log4js@^6.3.0: rfdc "^1.1.4" streamroller "^2.2.4" -lolex@^5.0.0: - version "5.1.2" - resolved "https://registry.yarnpkg.com/lolex/-/lolex-5.1.2.tgz#953694d098ce7c07bc5ed6d0e42bc6c0c6d5a367" - integrity sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A== - dependencies: - "@sinonjs/commons" "^1.7.0" - loose-envify@^1.0.0, loose-envify@^1.1.0, loose-envify@^1.4.0: version "1.4.0" resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" @@ -10290,17 +9669,6 @@ node-modules-regexp@^1.0.0: resolved "https://registry.yarnpkg.com/node-modules-regexp/-/node-modules-regexp-1.0.0.tgz#8d9dbe28964a4ac5712e9131642107c71e90ec40" integrity sha1-jZ2+KJZKSsVxLpExZCEHxx6Q7EA= -node-notifier@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/node-notifier/-/node-notifier-6.0.0.tgz#cea319e06baa16deec8ce5cd7f133c4a46b68e12" - integrity sha512-SVfQ/wMw+DesunOm5cKqr6yDcvUTDl/yc97ybGHMrteNEY6oekXpNpS3lZwgLlwz0FLgHoiW28ZpmBHUDg37cw== - dependencies: - growly "^1.3.0" - is-wsl "^2.1.1" - semver "^6.3.0" - shellwords "^0.1.1" - which "^1.3.1" - node-notifier@^8.0.0: version "8.0.0" resolved "https://registry.yarnpkg.com/node-notifier/-/node-notifier-8.0.0.tgz#a7eee2d51da6d0f7ff5094bc7108c911240c1620" @@ -10763,11 +10131,6 @@ p-finally@^1.0.0: resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae" integrity sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4= -p-finally@^2.0.0: - version "2.0.1" - resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-2.0.1.tgz#bd6fcaa9c559a096b680806f4d657b3f0f240561" - integrity sha512-vpm09aKwq6H9phqRQzecoDpD8TmVyGw70qmWlyq5onxY7tqyTTFVvxMykxQSQKILBSFlbXpypIw2T1Ml7+DDtw== - p-limit@^1.1.0: version "1.3.0" resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-1.3.0.tgz#b86bd5f0c25690911c7590fcbfc2010d54b3ccb8" @@ -12027,11 +11390,6 @@ readdir-scoped-modules@^1.0.0: graceful-fs "^4.1.2" once "^1.3.0" -realpath-native@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/realpath-native/-/realpath-native-2.0.0.tgz#7377ac429b6e1fd599dc38d08ed942d0d7beb866" - integrity sha512-v1SEYUOXXdbBZK8ZuNgO4TBjamPsiSgcFr0aP+tEKpQZK8vooEUqV6nm6Cv502mX4NF2EfsnVqtNAHG+/6Ur1Q== - rechoir@^0.6.2: version "0.6.2" resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.6.2.tgz#85204b54dba82d5742e28c96756ef43af50e3384" @@ -12168,7 +11526,7 @@ request-promise-core@1.1.4: dependencies: lodash "^4.17.19" -request-promise-native@^1.0.5, request-promise-native@^1.0.7, request-promise-native@^1.0.8: +request-promise-native@^1.0.5, request-promise-native@^1.0.8: version "1.0.9" resolved "https://registry.yarnpkg.com/request-promise-native/-/request-promise-native-1.0.9.tgz#e407120526a5efdc9a39b28a5679bf47b9d9dc28" integrity sha512-wcW+sIUiWnKgNY0dqCpOZkUbF/I+YPi+f09JZIDa39Ec+q82CpSYniDp+ISgTTbKmnpJWASeJBPZmoxH84wt3g== @@ -12252,11 +11610,6 @@ resolve-url@^0.2.1: resolved "https://registry.yarnpkg.com/resolve-url/-/resolve-url-0.2.1.tgz#2c637fe77c893afd2a663fe21aa9080068e2052a" integrity sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo= -resolve@1.1.7: - version "1.1.7" - resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.1.7.tgz#203114d82ad2c5ed9e8e0411b3932875e889e97b" - integrity sha1-IDEU2CrSxe2ejgQRs5ModeiJ6Xs= - resolve@^1.1.6, resolve@^1.10.0, resolve@^1.10.1, resolve@^1.11.1, resolve@^1.12.0, resolve@^1.13.1, resolve@^1.17.0, resolve@^1.3.2: version "1.17.0" resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.17.0.tgz#b25941b54968231cc2d1bb76a79cb7f2c0bf8444" @@ -12850,7 +12203,7 @@ stable@^0.1.8: resolved "https://registry.yarnpkg.com/stable/-/stable-0.1.8.tgz#836eb3c8382fe2936feaf544631017ce7d47a3cf" integrity sha512-ji9qxRnOVfcuLDySj9qzhGSEFVobyt1kIOSkj1qZzYLzq7Tos/oUUWvotUPQLlrsidqsK6tBH89Bc9kL5zHA6w== -stack-utils@^1.0.1, stack-utils@^1.0.2: +stack-utils@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/stack-utils/-/stack-utils-1.0.2.tgz#33eba3897788558bebfc2db059dc158ec36cebb8" integrity sha512-MTX+MeG5U994cazkjd/9KNAapsHnibjMLnfXodlkXw76JEea0UiNzrqidzo1emMwk7w5Qhc9jd4Bn9TBb1MFwA== @@ -12938,14 +12291,6 @@ string-argv@0.3.1: resolved "https://registry.yarnpkg.com/string-argv/-/string-argv-0.3.1.tgz#95e2fbec0427ae19184935f816d74aaa4c5c19da" integrity sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg== -string-length@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/string-length/-/string-length-3.1.0.tgz#107ef8c23456e187a8abd4a61162ff4ac6e25837" - integrity sha512-Ttp5YvkGm5v9Ijagtaz1BnN+k9ObpvS0eIBblPMp2YWL8FBmi9qblQ9fexc2k/CXFgrTIteU3jAw3payCnwSTA== - dependencies: - astral-regex "^1.0.0" - strip-ansi "^5.2.0" - string-length@^4.0.1: version "4.0.1" resolved "https://registry.yarnpkg.com/string-length/-/string-length-4.0.1.tgz#4a973bf31ef77c4edbceadd6af2611996985f8a1" @@ -14007,15 +13352,6 @@ v8-compile-cache@^2.0.0, v8-compile-cache@^2.0.3: resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.1.1.tgz#54bc3cdd43317bca91e35dcaf305b1a7237de745" integrity sha512-8OQ9CL+VWyt3JStj7HX7/ciTL2V3Rl1Wf5OL+SNTm0yK1KvtReVulksyeRnCANHHuUxHlQig+JJDlUhBt1NQDQ== -v8-to-istanbul@^4.1.3: - version "4.1.4" - resolved "https://registry.yarnpkg.com/v8-to-istanbul/-/v8-to-istanbul-4.1.4.tgz#b97936f21c0e2d9996d4985e5c5156e9d4e49cd6" - integrity sha512-Rw6vJHj1mbdK8edjR7+zuJrpDtKIgNdAvTSAcpYfgMIw+u2dPDntD3dgN4XQFLU2/fvFQdzj+EeSGfd/jnY5fQ== - dependencies: - "@types/istanbul-lib-coverage" "^2.0.1" - convert-source-map "^1.6.0" - source-map "^0.7.3" - v8-to-istanbul@^5.0.1: version "5.0.1" resolved "https://registry.yarnpkg.com/v8-to-istanbul/-/v8-to-istanbul-5.0.1.tgz#0608f5b49a481458625edb058488607f25498ba5" @@ -14319,7 +13655,7 @@ ws@^6.1.2, ws@^6.2.0: dependencies: async-limiter "~1.0.0" -ws@^7.0.0, ws@^7.2.3: +ws@^7.2.3: version "7.3.1" resolved "https://registry.yarnpkg.com/ws/-/ws-7.3.1.tgz#d0547bf67f7ce4f12a72dfe31262c68d7dc551c8" integrity sha512-D3RuNkynyHmEJIpD2qrgVkc9DQ23OrN/moAwZX4L8DfvszsJxpjQuUq3LMx6HoYji9fbIOBY18XWBsAux1ZZUA== @@ -14397,7 +13733,7 @@ yallist@^4.0.0: resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== -yaml@*, yaml@1.10.0, yaml@^1.10.0, yaml@^1.5.0, yaml@^1.7.2: +yaml@*, yaml@1.10.0, yaml@^1.10.0, yaml@^1.5.0: version "1.10.0" resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.0.tgz#3b593add944876077d4d683fee01081bd9fff31e" integrity sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg== From 217f09043acccaf80a60f4f95f877036b1e830e2 Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 13:03:31 +0300 Subject: [PATCH 14/36] add cdk8s as a dependency to mono packages --- packages/aws-cdk-lib/package.json | 4 +++- packages/monocdk-experiment/package.json | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/aws-cdk-lib/package.json b/packages/aws-cdk-lib/package.json index e60a75e06db76..46bc71101d6a5 100644 --- a/packages/aws-cdk-lib/package.json +++ b/packages/aws-cdk-lib/package.json @@ -258,6 +258,7 @@ "@types/node": "^10.17.35", "cdk-build-tools": "0.0.0", "constructs": "^3.0.4", + "cdk8s": "^0.29.0", "fs-extra": "^9.0.1", "pkglint": "0.0.0", "ts-node": "^9.0.0", @@ -265,7 +266,8 @@ "ubergen": "0.0.0" }, "peerDependencies": { - "constructs": "^3.0.4" + "constructs": "^3.0.4", + "cdk8s": "^0.29.0" }, "homepage": "https://github.com/aws/aws-cdk", "engines": { diff --git a/packages/monocdk-experiment/package.json b/packages/monocdk-experiment/package.json index 601234c3ae67f..5c01ac61b9053 100644 --- a/packages/monocdk-experiment/package.json +++ b/packages/monocdk-experiment/package.json @@ -257,6 +257,7 @@ "@types/node": "^10.17.35", "cdk-build-tools": "0.0.0", "constructs": "^3.0.4", + "cdk8s": "^0.29.0", "fs-extra": "^9.0.1", "pkglint": "0.0.0", "ts-node": "^9.0.0", @@ -264,7 +265,8 @@ "ubergen": "0.0.0" }, "peerDependencies": { - "constructs": "^3.0.4" + "constructs": "^3.0.4", + "cdk8s": "^0.29.0" }, "homepage": "https://github.com/aws/aws-cdk", "engines": { From c9e929b1ee484a5ac2170130a541dd913fd356bf Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 13:34:38 +0300 Subject: [PATCH 15/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 169 +++++++++++++++++++++++++--- packages/@aws-cdk/aws-eks/README.md | 124 -------------------- 2 files changed, 151 insertions(+), 142 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index 6b9313ea3239e..b18e7ad32532f 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -69,7 +69,7 @@ In addition, the library also supports defining Kubernetes resource manifests wi ## Provisioning clusters -Creating a new cluster is done using the `eks.Cluster` or `eks.FargateCluster` constructs. The only required property is the kubernetes version. +Creating a new cluster is done using the `Cluster` or `FargateCluster` constructs. The only required property is the kubernetes `version`. ```typescript new eks.Cluster(this, 'HelloEKS', { @@ -77,7 +77,7 @@ new eks.Cluster(this, 'HelloEKS', { }); ``` -You can also use `eks.FargateCluster` to provision a managed cluster that uses fargate workers. +You can also use `FargateCluster` to provision a cluster that uses only fargate workers. ```typescript new eks.FargateCluster(this, 'HelloEKS', { @@ -85,9 +85,9 @@ new eks.FargateCluster(this, 'HelloEKS', { }); ``` -> **NOTE: You can only create 1 cluster per stack.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see https://github.com/aws/aws-cdk/issues/10073. +> **NOTE: Only 1 cluster per stack is supported.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see https://github.com/aws/aws-cdk/issues/10073. -There are various ways to customize to cluster. The first important concept to understand is **capacity**. +Below you'll find a few important cluster configuration options. ### Capacity @@ -104,7 +104,7 @@ With Amazon EKS managed node groups, you don’t need to separately provision or By default, this library will allocate a managed node group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). -At cluster instatiation time, you can customize the number of instances and their type: +At cluster instantiation time, you can customize the number of instances and their type: ```typescript new eks.Cluster(this, 'HelloEKS', { @@ -114,7 +114,9 @@ new eks.Cluster(this, 'HelloEKS', { }); ``` -Additional customizations are available post instatiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroupCapacity` method: +To access the node group that was created on your behalf, you can use `cluster.defaultNodegroup`. + +Additional customizations are available post instantiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroupCapacity` method: ```typescript const cluster = new eks.Cluster(this, 'HelloEKS', { @@ -133,20 +135,9 @@ cluster.addNodegroupCapacity('custom-node-group', { > For a complete API reference visit [`NodegroupOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupOptions.html). -You can also directly use the `eks.Nodegroup` construct to create node groups under different scopes: - -```typescript -new eks.Nodegroup(scope, 'NodeGroup', { - cluster: cluster, - ... -}); -``` - -> For a complete API reference visit [`NodegroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupProps.html). - ##### Launch Template Support -You can specify a launch template that the node group will use.. Note that when using a custom AMI, Amazon EKS doesn't merge any user data. +You can specify a launch template that the node group will use. Note that when using a custom AMI, Amazon EKS doesn't merge any user data. Rather, You are responsible for supplying the required bootstrap commands for nodes to join the cluster. In the following example, `/ect/eks/bootstrap.sh` from the AMI will be used to bootstrap the node. @@ -175,9 +166,140 @@ cluster.addNodegroupCapacity('extra-ng', { #### 2) Fargate Profiles +AWS Fargate is a technology that provides on-demand, right-sized compute +capacity for containers. With AWS Fargate, you no longer have to provision, +configure, or scale groups of virtual machines to run containers. This removes +the need to choose server types, decide when to scale your node groups, or +optimize cluster packing. + +You can control which pods start on Fargate and how they run with Fargate +Profiles, which are defined as part of your Amazon EKS cluster. + +See [Fargate Considerations](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html#fargate-considerations) in the AWS EKS User Guide. + +You can add Fargate Profiles to any EKS cluster defined in your CDK app +through the `addFargateProfile()` method. The following example adds a profile +that will match all pods from the "default" namespace: + +```ts +cluster.addFargateProfile('MyProfile', { + selectors: [ { namespace: 'default' } ] +}); +``` + +> For a complete API reference visit [`FargateProfileOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.FargateProfileOptions.html) + +You can also directly use the `FargateProfile` construct to create profiles under different scopes: + +```ts +new eks.FargateProfile(scope, 'MyProfile', { + cluster, + ... +}); +``` + +> For a complete API reference visit [`FargateProfileProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.FargateProfileProps.html) + +To create an EKS cluster that **only** uses Fargate capacity, you can use `FargateCluster`. +The following code defines an Amazon EKS cluster with a default Fargate Profile that matches all pods from the "kube-system" and "default" namespaces. It is also configured to [run CoreDNS on Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns). + +```ts +const cluster = new eks.FargateCluster(this, 'MyCluster', { + version: eks.KubernetesVersion.V1_16, +}); +``` + +**NOTE**: Classic Load Balancers and Network Load Balancers are not supported on +pods running on Fargate. For ingress, we recommend that you use the [ALB Ingress +Controller](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) +on Amazon EKS (minimum version v1.1.4). + #### 3) Self Managed Auto Scaling Groups +Another way of allocating capacity to an EKS cluster is by using self-managed Auto Scaling Groups. +EC2 instances that are part of the auto-scaling-group will serve as worker nodes for the cluster. +This type of capacity is also commonly referred to as *EC2 Capacity** or *EC2 Nodes*. + +For a detailed overview please visit [Self Managed Nodes](https://docs.aws.amazon.com/eks/latest/userguide/worker.html). + +These self-managed auto-scaling-groups provide some additional capabilities over the managed node group, as detailed below. +However, as they incur an extra maintenance overhead, they are usually not considered a best practice. + +Creating an auto-scaling-group and connecting it to the cluster is done using the `cluster.addAutoScalingGroupCapacity` method: + +```ts +cluster.addAutoScalingGroupCapacity('frontend-nodes', { + instanceType: new ec2.InstanceType('t2.medium'), + minCapacity: 3, + vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } +}); +``` + +You can customize the [/etc/eks/boostrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) script, which is responsible +for bootstrapping the node to the EKS cluster. For example, you can use `kubeletExtraArgs` to add custom node labels or taints. + +```ts +cluster.addAutoScalingGroupCapacity('spot', { + instanceType: new ec2.InstanceType('t3.large'), + minCapacity: 2, + bootstrapOptions: { + kubeletExtraArgs: '--node-labels foo=bar,goo=far', + awsApiRetryAttempts: 5 + } +}); +``` + +To disable bootstrapping altogether (i.e. to fully customize user-data), set `bootstrapEnabled` to `false`. + +> For a complete API reference please visit [`AutoScalingGroupCapacityOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.CapacityOptions.html) + +You can also configure the cluster to use an auto-scaling-group as the default capacity: + +```ts +cluster = new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + defaultCapacityType: eks.DefaultCapacityType.EC2, +}); +``` + +This will allocate an auto-scaling-group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). +To access the `AutoScalingGroup` that was created on your behalf, you can use `cluster.defaultCapacity`. +You can also independently create an `AutoScalingGroup` and connect it to the cluster using the `cluster.connectAutoScalingGroupCapacity` method: + +```ts +const asg = new ec2.AutoScalingGroup(...) +cluster.connectAutoScalingGroupCapacity(asg); +``` + +This will add the necessary user-data and configure all connections, roles, and tags needed for the instances in the auto-scaling-group to properly join the cluster. +##### Spot Instances + +When using self-managed nodes, you can configure the capacity to use spot instances, greatly reducing capacity cost. +To enable spot capacity, use the `spotPrice` property: + +```ts +cluster.addAutoScalingGroupCapacity('spot', { + spotPrice: '0.1094', + instanceType: new ec2.InstanceType('t3.large'), + maxCapacity: 10 +}); +``` + +> Spot instance nodes will be labeled with `lifecycle=Ec2Spot` and tainted with `PreferNoSchedule`. + +The [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) `DaemonSet` will be +installed from [Amazon EKS Helm chart repository](https://github.com/aws/eks-charts/tree/master/stable/aws-node-termination-handler) on these nodes. +The termination handler ensures that the Kubernetes control plane responds appropriately to events that +can cause your EC2 instance to become unavailable, such as [EC2 maintenance events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) +and [EC2 Spot interruptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) and helps gracefully stop all pods running on spot nodes that are about to be +terminated. + +> Handler Version: [1.7.0](https://github.com/aws/aws-node-termination-handler/releases/tag/v1.7.0) +> +> Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) + +##### BottleRocket ### VPC Support @@ -202,6 +324,17 @@ The default value is `eks.EndpointAccess.PUBLIC_AND_PRIVATE`. Which means the cl ## Using existing clusters +You can also directly use the `Nodegroup` construct to create node groups under different scopes: + +```typescript +new eks.Nodegroup(scope, 'NodeGroup', { + cluster: cluster, + ... +}); +``` + +> For a complete API reference visit [`NodegroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupProps.html). + ## Managing Objects ### Applying diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index a02e30e6e075b..a2a7817a8eba2 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -65,60 +65,6 @@ pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m ... ``` -### Capacity - -By default, `eks.Cluster` is created with a managed nodegroup with x2 `m5.large` instances. You must specify the kubernetes version for the cluster with the `version` property. - -```ts -new eks.Cluster(this, 'cluster-two-m5-large', { - version: eks.KubernetesVersion.V1_16, -}); -``` - -To use the traditional self-managed Amazon EC2 instances instead, set `defaultCapacityType` to `DefaultCapacityType.EC2` - -```ts -const cluster = new eks.Cluster(this, 'cluster-self-managed-ec2', { - defaultCapacityType: eks.DefaultCapacityType.EC2, - version: eks.KubernetesVersion.V1_16, -}); -``` - -The quantity and instance type for the default capacity can be specified through -the `defaultCapacity` and `defaultCapacityInstance` props: - -```ts -new eks.Cluster(this, 'cluster', { - defaultCapacity: 10, - defaultCapacityInstance: new ec2.InstanceType('m2.xlarge'), - version: eks.KubernetesVersion.V1_16, -}); -``` - -To disable the default capacity, simply set `defaultCapacity` to `0`: - -```ts -new eks.Cluster(this, 'cluster-with-no-capacity', { - defaultCapacity: 0, - version: eks.KubernetesVersion.V1_16, -}); -``` - -When creating a cluster with default capacity (i.e `defaultCapacity !== 0` or is undefined), you can access the allocated capacity using: - -- `cluster.defaultCapacity` will reference the `AutoScalingGroup` resource in case `defaultCapacityType` is set to `EC2` or is undefined. -- `cluster.defaultNodegroup` will reference the `Nodegroup` resource in case `defaultCapacityType` is set to `NODEGROUP`. - -You can add customized capacity in the form of an `AutoScalingGroup` resource through `cluster.addAutoScalingGroupCapacity()`: - -```ts -cluster.addAutoScalingGroupCapacity('frontend-nodes', { - instanceType: new ec2.InstanceType('t2.medium'), - minCapacity: 3, - vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } -}); -``` - ### ARM64 Support Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest @@ -146,76 +92,6 @@ cluster.addAutoScalingGroupCapacity('self-ng-arm', { ### Fargate -AWS Fargate is a technology that provides on-demand, right-sized compute -capacity for containers. With AWS Fargate, you no longer have to provision, -configure, or scale groups of virtual machines to run containers. This removes -the need to choose server types, decide when to scale your node groups, or -optimize cluster packing. - -You can control which pods start on Fargate and how they run with Fargate -Profiles, which are defined as part of your Amazon EKS cluster. - -See [Fargate -Considerations](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html#fargate-considerations) -in the AWS EKS User Guide. - -You can add Fargate Profiles to any EKS cluster defined in your CDK app -through the `addFargateProfile()` method. The following example adds a profile -that will match all pods from the "default" namespace: - -```ts -cluster.addFargateProfile('MyProfile', { - selectors: [ { namespace: 'default' } ] -}); -``` - -To create an EKS cluster that **only** uses Fargate capacity, you can use -`FargateCluster`. - -The following code defines an Amazon EKS cluster without EC2 capacity and a default -Fargate Profile that matches all pods from the "kube-system" and "default" namespaces. It is also configured to [run CoreDNS on Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns) through the `coreDnsComputeType` cluster option. - -```ts -const cluster = new eks.FargateCluster(this, 'MyCluster', { - version: eks.KubernetesVersion.V1_16, -}); - - // apply k8s resources on this cluster -cluster.addManifest(...); -``` - -**NOTE**: Classic Load Balancers and Network Load Balancers are not supported on -pods running on Fargate. For ingress, we recommend that you use the [ALB Ingress -Controller](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) -on Amazon EKS (minimum version v1.1.4). - -### Spot Capacity - -If `spotPrice` is specified, the capacity will be purchased from spot instances: - -```ts -cluster.addAutoScalingGroupCapacity('spot', { - spotPrice: '0.1094', - instanceType: new ec2.InstanceType('t3.large'), - maxCapacity: 10 -}); -``` - -Spot instance nodes will be labeled with `lifecycle=Ec2Spot` and tainted with `PreferNoSchedule`. - -The [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) -DaemonSet will be installed from [ -Amazon EKS Helm chart repository -](https://github.com/aws/eks-charts/tree/master/stable/aws-node-termination-handler) on these nodes. -The termination handler ensures that the Kubernetes control plane responds appropriately to events that -can cause your EC2 instance to become unavailable, such as [EC2 maintenance events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) -and [EC2 Spot interruptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) and helps gracefully stop all pods running on spot nodes that are about to be -terminated. - -> Handler Version: [1.7.0](https://github.com/aws/aws-node-termination-handler/releases/tag/v1.7.0) -> -> Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) - ### Bootstrapping When adding capacity, you can specify options for From 42a4f72f4c31a17309ac7d2e04f8371e80272a84 Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 14:20:08 +0300 Subject: [PATCH 16/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 121 +++++++++++++++++++++++- packages/@aws-cdk/aws-eks/README.md | 141 ---------------------------- 2 files changed, 118 insertions(+), 144 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md index b18e7ad32532f..c3dfb8ff63309 100644 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ b/packages/@aws-cdk/aws-eks/GUIDE.md @@ -37,9 +37,64 @@ In addition, the library also supports defining Kubernetes resource manifests wi ## Quick Start +This example defines an Amazon EKS cluster with the following configuration: +- Dedicated VPC with default configuration (see [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) +- A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. -## Overview +```ts +// provisiong a cluster +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_16, +}); + +// apply a kubernetes manifest to the cluster +cluster.addManifest('mypod', { + apiVersion: 'v1', + kind: 'Pod', + metadata: { name: 'mypod' }, + spec: { + containers: [ + { + name: 'hello', + image: 'paulbouwer/hello-kubernetes:1.5', + ports: [ { containerPort: 8080 } ] + } + ] + } +}); +``` + +In order to interact with your cluster through `kubectl`, you can use the `aws eks update-kubeconfig` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) +to configure your local kubeconfig. The EKS module will define a CloudFormation output in your stack which contains the command to run. For example: + +``` +Outputs: +ClusterConfigCommand43AAE40F = aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy +``` + +Execute the `aws eks update-kubeconfig ... ` command in your terminal to create or update a local kubeconfig context: + +```console +$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy +Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config +``` + +And now you can simply use `kubectl`: + +```console +$ kubectl get all -n kube-system +NAME READY STATUS RESTARTS AGE +pod/aws-node-fpmwv 1/1 Running 0 21m +pod/aws-node-m9htf 1/1 Running 0 21m +pod/coredns-5cb4fb54c7-q222j 1/1 Running 0 23m +pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m +... +``` + +## Architectural Overview + +The following is a qualitative diagram of the various possible components involved in the cluster deployment. ```text +-----------------------------------------------+ +-----------------+ @@ -66,6 +121,16 @@ In addition, the library also supports defining Kubernetes resource manifests wi +--------------------+ ``` +In a nutshell: + +- `EKS Cluster` - The cluster endpoint created by EKS. +- `Managed Node Group` - EC2 worker nodes managed by EKS. +- `Fargate Profile` - Fargate worker nodes managed by EKS. +- `Auto Scaling Group` - EC2 worker nodes managed by the user. +- `KubectlHandler` - Lambda function for invoking `kubectl` commands on the cluster - created by CDK. +- `ClusterHandler` - Lambda function for interacting with EKS API to manage the cluster lifecycle - created by CDK. + +A more detailed breakdown of each is provided further down this README. ## Provisioning clusters @@ -91,7 +156,7 @@ Below you'll find a few important cluster configuration options. ### Capacity -Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity: +Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity, which you can combine as you like: #### 1) Managed Node Groups @@ -299,7 +364,49 @@ terminated. > > Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) -##### BottleRocket +##### Bottlerocket + +[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open-source operating system that is purpose-built by Amazon Web Services for running containers on virtual machines or bare metal hosts. +At this moment, `Bottlerocket` is only supported when using self-managed auto-scaling-groups. + +> **NOTICE**: Bottlerocket is only available in [some supported AWS regions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/QUICKSTART-EKS.md#finding-an-ami). + +The following example will create an auto-scaling-group of 2 `t3.small` Linux instances running with the `Bottlerocket` AMI. + +```ts +cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { + instanceType: new ec2.InstanceType('t3.small'), + minCapacity: 2, + machineImageType: eks.MachineImageType.BOTTLEROCKET +}); +``` + +The specific Bottlerocket AMI variant will be auto selected according to the k8s version for the `x86_64` architecture. +For example, if the Amazon EKS cluster version is `1.17`, the Bottlerocket AMI variant will be auto selected as +`aws-k8s-1.17` behind the scene. + +> See [Variants](https://github.com/bottlerocket-os/bottlerocket/blob/develop/README.md#variants) for more details. + +Please note Bottlerocket does not allow to customize bootstrap options and `bootstrapOptions` properties is not supported when you create the `Bottlerocket` capacity. + +### ARM64 Support + +Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest +Amazon Linux 2 AMI for ARM64 will be automatically selected. + +```ts +// add a managed ARM64 nodegroup +cluster.addNodegroup('extra-ng-arm', { + instanceType: new ec2.InstanceType('m6g.medium'), + minSize: 2, +}); + +// add a self-managed ARM64 nodegroup +cluster.addAutoScalingGroupCapacity('self-ng-arm', { + instanceType: new ec2.InstanceType('m6g.medium'), + minCapacity: 2, +}) +``` ### VPC Support @@ -322,6 +429,14 @@ The default value is `eks.EndpointAccess.PUBLIC_AND_PRIVATE`. Which means the cl ### Permissions +> The IAM role specified in this command is called the "**masters role**". This is +> an IAM role that is associated with the `system:masters` [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) +> group and has super-user access to the cluster. +> +> You can specify this role using the `mastersRole` option, or otherwise a role will be +> automatically created for you. This role can be assumed by anyone in the account with +> `sts:AssumeRole` permissions for this role. + ## Using existing clusters You can also directly use the `Nodegroup` construct to create node groups under different scopes: diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index a2a7817a8eba2..ab6077a57f667 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -1,119 +1,3 @@ -This example defines an Amazon EKS cluster with the following configuration: - -- Dedicated VPC with default configuration (see [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) -- A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. - -```ts -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_16, -}); - -// apply a kubernetes manifest to the cluster -cluster.addManifest('mypod', { - apiVersion: 'v1', - kind: 'Pod', - metadata: { name: 'mypod' }, - spec: { - containers: [ - { - name: 'hello', - image: 'paulbouwer/hello-kubernetes:1.5', - ports: [ { containerPort: 8080 } ] - } - ] - } -}); -``` - -In order to interact with your cluster through `kubectl`, you can use the `aws -eks update-kubeconfig` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) -to configure your local kubeconfig. - -The EKS module will define a CloudFormation output in your stack which contains -the command to run. For example: - -``` -Outputs: -ClusterConfigCommand43AAE40F = aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy -``` - -> The IAM role specified in this command is called the "**masters role**". This is -> an IAM role that is associated with the `system:masters` [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) -> group and has super-user access to the cluster. -> -> You can specify this role using the `mastersRole` option, or otherwise a role will be -> automatically created for you. This role can be assumed by anyone in the account with -> `sts:AssumeRole` permissions for this role. - -Execute the `aws eks update-kubeconfig ...` command in your terminal to create a -local kubeconfig: - -```console -$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy -Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config -``` - -And now you can simply use `kubectl`: - -```console -$ kubectl get all -n kube-system -NAME READY STATUS RESTARTS AGE -pod/aws-node-fpmwv 1/1 Running 0 21m -pod/aws-node-m9htf 1/1 Running 0 21m -pod/coredns-5cb4fb54c7-q222j 1/1 Running 0 23m -pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m -... -``` - -### ARM64 Support - -Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest -Amazon Linux 2 AMI for ARM64 will be automatically selected. - -```ts -// create a cluster with a default managed nodegroup -cluster = new eks.Cluster(this, 'Cluster', { - vpc, - version: eks.KubernetesVersion.V1_17, -}); - -// add a managed ARM64 nodegroup -cluster.addNodegroup('extra-ng-arm', { - instanceType: new ec2.InstanceType('m6g.medium'), - minSize: 2, -}); - -// add a self-managed ARM64 nodegroup -cluster.addAutoScalingGroupCapacity('self-ng-arm', { - instanceType: new ec2.InstanceType('m6g.medium'), - minCapacity: 2, -}) -``` - -### Fargate - -### Bootstrapping - -When adding capacity, you can specify options for -[/etc/eks/boostrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) -which is responsible for associating the node to the EKS cluster. For example, -you can use `kubeletExtraArgs` to add custom node labels or taints. - -```ts -// up to ten spot instances -cluster.addAutoScalingGroupCapacity('spot', { - instanceType: new ec2.InstanceType('t3.large'), - minCapacity: 2, - bootstrapOptions: { - kubeletExtraArgs: '--node-labels foo=bar,goo=far', - awsApiRetryAttempts: 5 - } -}); -``` - -To disable bootstrapping altogether (i.e. to fully customize user-data), set `bootstrapEnabled` to `false` when you add -the capacity. - ### Kubernetes Manifests The `KubernetesManifest` construct or `cluster.addManifest` method can be used @@ -512,31 +396,6 @@ const chart2 = cluster.addHelmChart(...); chart2.node.addDependency(chart1); ``` -### Bottlerocket - -[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open-source operating system that is purpose-built by Amazon Web Services for running containers on virtual machines or bare metal hosts. At this moment the managed nodegroup only supports Amazon EKS-optimized AMI but it's possible to create a capacity of self-managed `AutoScalingGroup` running with bottlerocket Linux AMI. - -> **NOTICE**: Bottlerocket is only available in [some supported AWS regions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/QUICKSTART-EKS.md#finding-an-ami). - -The following example will create a capacity with self-managed Amazon EC2 capacity of 2 `t3.small` Linux instances running with `Bottlerocket` AMI. - -```ts -// add bottlerocket nodes -cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { - instanceType: new ec2.InstanceType('t3.small'), - minCapacity: 2, - machineImageType: eks.MachineImageType.BOTTLEROCKET -}); -``` - -The Bottlerocket AMI will be auto selected with the variant of different k8s version for the `x86_64` architecture. -For example, if the Amazon EKS cluster version is `1.17`, the Bottlerocket AMI variant will be auto selected as -`aws-k8s-1.17` behind the scene. See [Variants](https://github.com/bottlerocket-os/bottlerocket/blob/develop/README.md#variants) for more details. - -To define only Bottlerocket capacity in your cluster, set `defaultCapacity` to `0` when you define the cluster as described above. - -Please note Bottlerocket does not allow to customize bootstrap options and `bootstrapOptions` properties is not supported when you create the `Bottlerocket` capacity. - ### Service Accounts With services account you can provide Kubernetes Pods access to AWS resources. From 20d17a6e71b389ff725219b9adaab87bd2bf988a Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 19:13:33 +0300 Subject: [PATCH 17/36] mid work --- packages/@aws-cdk/aws-eks/GUIDE.md | 465 -------------- packages/@aws-cdk/aws-eks/README.md | 931 +++++++++++++++++++++------- 2 files changed, 700 insertions(+), 696 deletions(-) delete mode 100644 packages/@aws-cdk/aws-eks/GUIDE.md diff --git a/packages/@aws-cdk/aws-eks/GUIDE.md b/packages/@aws-cdk/aws-eks/GUIDE.md deleted file mode 100644 index c3dfb8ff63309..0000000000000 --- a/packages/@aws-cdk/aws-eks/GUIDE.md +++ /dev/null @@ -1,465 +0,0 @@ -## Amazon EKS Construct Library - ---- - -![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) - -> All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use. - -![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.svg?style=for-the-badge) - -> The APIs of higher level constructs in this module are in **developer preview** before they become stable. We will only make breaking changes to address unforeseen API issues. Therefore, these APIs are not subject to [Semantic Versioning](https://semver.org/), and breaking changes will be announced in release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package. - ---- - - -This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. -In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. - -* [Quick Start](#quick-start) -* [Overview](#overview) -* [Provisioning clusters](#provisioning-clusters) - * [Capacity](#capacity) - * [Managed Node Groups](#1-managed-node-groups) - * [Fargate Profiles](#2-fargate-profiles) - * [Self Managed Auto Scaling Groups](#3-self-managed-auto-scaling-groups) - * [VPC Support](#vpc-support) - * [Endpoint Access](#endpoint-access) - * [Permissions](#permissions) -* [Using existing clusters](#using-existing-clusters) -* [Managing Objects](#managing-objects) - * [Applying](#applying) - * [Kubernetes Manifests](#kubernetes-manifests) - * [Helm Charts](#helm-charts) - * [Patching](#patching) - * [Querying](#querying) -* [Known Issues](#known-issues) - -## Quick Start - -This example defines an Amazon EKS cluster with the following configuration: - -- Dedicated VPC with default configuration (see [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) -- A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. - -```ts -// provisiong a cluster -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_16, -}); - -// apply a kubernetes manifest to the cluster -cluster.addManifest('mypod', { - apiVersion: 'v1', - kind: 'Pod', - metadata: { name: 'mypod' }, - spec: { - containers: [ - { - name: 'hello', - image: 'paulbouwer/hello-kubernetes:1.5', - ports: [ { containerPort: 8080 } ] - } - ] - } -}); -``` - -In order to interact with your cluster through `kubectl`, you can use the `aws eks update-kubeconfig` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) -to configure your local kubeconfig. The EKS module will define a CloudFormation output in your stack which contains the command to run. For example: - -``` -Outputs: -ClusterConfigCommand43AAE40F = aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy -``` - -Execute the `aws eks update-kubeconfig ... ` command in your terminal to create or update a local kubeconfig context: - -```console -$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy -Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config -``` - -And now you can simply use `kubectl`: - -```console -$ kubectl get all -n kube-system -NAME READY STATUS RESTARTS AGE -pod/aws-node-fpmwv 1/1 Running 0 21m -pod/aws-node-m9htf 1/1 Running 0 21m -pod/coredns-5cb4fb54c7-q222j 1/1 Running 0 23m -pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m -... -``` - -## Architectural Overview - -The following is a qualitative diagram of the various possible components involved in the cluster deployment. - -```text - +-----------------------------------------------+ +-----------------+ - | EKS Cluster | kubectl | | - |-----------------------------------------------|<-------------+| Kubectl Handler | - | | | | - | | +-----------------+ - | +--------------------+ +-----------------+ | - | | | | | | - | | Managed Node Group | | Fargate Profile | | +-----------------+ - | | | | | | | | - | +--------------------+ +-----------------+ | | Cluster Handler | - | | | | - +-----------------------------------------------+ +-----------------+ - ^ ^ + - | | | - | connect self managed capacity | | aws-sdk - | | create/update/delete | - + | v - +--------------------+ + +-------------------+ - | | --------------+| eks.amazonaws.com | - | Auto Scaling Group | +-------------------+ - | | - +--------------------+ -``` - -In a nutshell: - -- `EKS Cluster` - The cluster endpoint created by EKS. -- `Managed Node Group` - EC2 worker nodes managed by EKS. -- `Fargate Profile` - Fargate worker nodes managed by EKS. -- `Auto Scaling Group` - EC2 worker nodes managed by the user. -- `KubectlHandler` - Lambda function for invoking `kubectl` commands on the cluster - created by CDK. -- `ClusterHandler` - Lambda function for interacting with EKS API to manage the cluster lifecycle - created by CDK. - -A more detailed breakdown of each is provided further down this README. - -## Provisioning clusters - -Creating a new cluster is done using the `Cluster` or `FargateCluster` constructs. The only required property is the kubernetes `version`. - -```typescript -new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_17, -}); -``` - -You can also use `FargateCluster` to provision a cluster that uses only fargate workers. - -```typescript -new eks.FargateCluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_17, -}); -``` - -> **NOTE: Only 1 cluster per stack is supported.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see https://github.com/aws/aws-cdk/issues/10073. - -Below you'll find a few important cluster configuration options. - -### Capacity - -Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity, which you can combine as you like: - -#### 1) Managed Node Groups - -Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. -With Amazon EKS managed node groups, you don’t need to separately provision or register the Amazon EC2 instances that provide compute capacity to run your Kubernetes applications. You can create, update, or terminate nodes for your cluster with a single operation. Nodes run using the latest Amazon EKS optimized AMIs in your AWS account while node updates and terminations gracefully drain nodes to ensure that your applications stay available. - -> For more details visit [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). - -**Managed Node Groups are the recommended way to allocate cluster capacity.** - -By default, this library will allocate a managed node group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). - -At cluster instantiation time, you can customize the number of instances and their type: - -```typescript -new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_17, - defaultCapacity: 5, - defaultCapacityInstance: ec2.InstanceType.of(ec2.InstanceClass.M5, ec2.InstanceSize.SMALL), -}); -``` - -To access the node group that was created on your behalf, you can use `cluster.defaultNodegroup`. - -Additional customizations are available post instantiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroupCapacity` method: - -```typescript -const cluster = new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_17, - defaultCapacity: 0, -}); - -cluster.addNodegroupCapacity('custom-node-group', { - instanceType: new ec2.InstanceType('m5.large'), - minSize: 4, - diskSize: 100, - amiType: eks.NodegroupAmiType.AL2_X86_64_GPU, - ... -}); -``` - -> For a complete API reference visit [`NodegroupOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupOptions.html). - -##### Launch Template Support - -You can specify a launch template that the node group will use. Note that when using a custom AMI, Amazon EKS doesn't merge any user data. -Rather, You are responsible for supplying the required bootstrap commands for nodes to join the cluster. -In the following example, `/ect/eks/bootstrap.sh` from the AMI will be used to bootstrap the node. - -```ts -const userData = ec2.UserData.forLinux(); -userData.addCommands( - 'set -o xtrace', - `/etc/eks/bootstrap.sh ${cluster.clusterName}`, -); -const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { - launchTemplateData: { - imageId: 'some-ami-id', // custom AMI - instanceType: new ec2.InstanceType('t3.small').toString(), - userData: Fn.base64(userData.render()), - }, -}); -cluster.addNodegroupCapacity('extra-ng', { - launchTemplateSpec: { - id: lt.ref, - version: lt.attrDefaultVersionNumber, - }, -}); -``` - -> For more details visit [Launch Template Support](https://docs.aws.amazon.com/en_ca/eks/latest/userguide/launch-templates.html). - -#### 2) Fargate Profiles - -AWS Fargate is a technology that provides on-demand, right-sized compute -capacity for containers. With AWS Fargate, you no longer have to provision, -configure, or scale groups of virtual machines to run containers. This removes -the need to choose server types, decide when to scale your node groups, or -optimize cluster packing. - -You can control which pods start on Fargate and how they run with Fargate -Profiles, which are defined as part of your Amazon EKS cluster. - -See [Fargate Considerations](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html#fargate-considerations) in the AWS EKS User Guide. - -You can add Fargate Profiles to any EKS cluster defined in your CDK app -through the `addFargateProfile()` method. The following example adds a profile -that will match all pods from the "default" namespace: - -```ts -cluster.addFargateProfile('MyProfile', { - selectors: [ { namespace: 'default' } ] -}); -``` - -> For a complete API reference visit [`FargateProfileOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.FargateProfileOptions.html) - -You can also directly use the `FargateProfile` construct to create profiles under different scopes: - -```ts -new eks.FargateProfile(scope, 'MyProfile', { - cluster, - ... -}); -``` - -> For a complete API reference visit [`FargateProfileProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.FargateProfileProps.html) - -To create an EKS cluster that **only** uses Fargate capacity, you can use `FargateCluster`. -The following code defines an Amazon EKS cluster with a default Fargate Profile that matches all pods from the "kube-system" and "default" namespaces. It is also configured to [run CoreDNS on Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns). - -```ts -const cluster = new eks.FargateCluster(this, 'MyCluster', { - version: eks.KubernetesVersion.V1_16, -}); -``` - -**NOTE**: Classic Load Balancers and Network Load Balancers are not supported on -pods running on Fargate. For ingress, we recommend that you use the [ALB Ingress -Controller](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) -on Amazon EKS (minimum version v1.1.4). - -#### 3) Self Managed Auto Scaling Groups - -Another way of allocating capacity to an EKS cluster is by using self-managed Auto Scaling Groups. -EC2 instances that are part of the auto-scaling-group will serve as worker nodes for the cluster. -This type of capacity is also commonly referred to as *EC2 Capacity** or *EC2 Nodes*. - -For a detailed overview please visit [Self Managed Nodes](https://docs.aws.amazon.com/eks/latest/userguide/worker.html). - -These self-managed auto-scaling-groups provide some additional capabilities over the managed node group, as detailed below. -However, as they incur an extra maintenance overhead, they are usually not considered a best practice. - -Creating an auto-scaling-group and connecting it to the cluster is done using the `cluster.addAutoScalingGroupCapacity` method: - -```ts -cluster.addAutoScalingGroupCapacity('frontend-nodes', { - instanceType: new ec2.InstanceType('t2.medium'), - minCapacity: 3, - vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } -}); -``` - -You can customize the [/etc/eks/boostrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) script, which is responsible -for bootstrapping the node to the EKS cluster. For example, you can use `kubeletExtraArgs` to add custom node labels or taints. - -```ts -cluster.addAutoScalingGroupCapacity('spot', { - instanceType: new ec2.InstanceType('t3.large'), - minCapacity: 2, - bootstrapOptions: { - kubeletExtraArgs: '--node-labels foo=bar,goo=far', - awsApiRetryAttempts: 5 - } -}); -``` - -To disable bootstrapping altogether (i.e. to fully customize user-data), set `bootstrapEnabled` to `false`. - -> For a complete API reference please visit [`AutoScalingGroupCapacityOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.CapacityOptions.html) - -You can also configure the cluster to use an auto-scaling-group as the default capacity: - -```ts -cluster = new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_17, - defaultCapacityType: eks.DefaultCapacityType.EC2, -}); -``` - -This will allocate an auto-scaling-group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). -To access the `AutoScalingGroup` that was created on your behalf, you can use `cluster.defaultCapacity`. -You can also independently create an `AutoScalingGroup` and connect it to the cluster using the `cluster.connectAutoScalingGroupCapacity` method: - -```ts -const asg = new ec2.AutoScalingGroup(...) -cluster.connectAutoScalingGroupCapacity(asg); -``` - -This will add the necessary user-data and configure all connections, roles, and tags needed for the instances in the auto-scaling-group to properly join the cluster. - -##### Spot Instances - -When using self-managed nodes, you can configure the capacity to use spot instances, greatly reducing capacity cost. -To enable spot capacity, use the `spotPrice` property: - -```ts -cluster.addAutoScalingGroupCapacity('spot', { - spotPrice: '0.1094', - instanceType: new ec2.InstanceType('t3.large'), - maxCapacity: 10 -}); -``` - -> Spot instance nodes will be labeled with `lifecycle=Ec2Spot` and tainted with `PreferNoSchedule`. - -The [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) `DaemonSet` will be -installed from [Amazon EKS Helm chart repository](https://github.com/aws/eks-charts/tree/master/stable/aws-node-termination-handler) on these nodes. -The termination handler ensures that the Kubernetes control plane responds appropriately to events that -can cause your EC2 instance to become unavailable, such as [EC2 maintenance events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) -and [EC2 Spot interruptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) and helps gracefully stop all pods running on spot nodes that are about to be -terminated. - -> Handler Version: [1.7.0](https://github.com/aws/aws-node-termination-handler/releases/tag/v1.7.0) -> -> Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) - -##### Bottlerocket - -[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open-source operating system that is purpose-built by Amazon Web Services for running containers on virtual machines or bare metal hosts. -At this moment, `Bottlerocket` is only supported when using self-managed auto-scaling-groups. - -> **NOTICE**: Bottlerocket is only available in [some supported AWS regions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/QUICKSTART-EKS.md#finding-an-ami). - -The following example will create an auto-scaling-group of 2 `t3.small` Linux instances running with the `Bottlerocket` AMI. - -```ts -cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { - instanceType: new ec2.InstanceType('t3.small'), - minCapacity: 2, - machineImageType: eks.MachineImageType.BOTTLEROCKET -}); -``` - -The specific Bottlerocket AMI variant will be auto selected according to the k8s version for the `x86_64` architecture. -For example, if the Amazon EKS cluster version is `1.17`, the Bottlerocket AMI variant will be auto selected as -`aws-k8s-1.17` behind the scene. - -> See [Variants](https://github.com/bottlerocket-os/bottlerocket/blob/develop/README.md#variants) for more details. - -Please note Bottlerocket does not allow to customize bootstrap options and `bootstrapOptions` properties is not supported when you create the `Bottlerocket` capacity. - -### ARM64 Support - -Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest -Amazon Linux 2 AMI for ARM64 will be automatically selected. - -```ts -// add a managed ARM64 nodegroup -cluster.addNodegroup('extra-ng-arm', { - instanceType: new ec2.InstanceType('m6g.medium'), - minSize: 2, -}); - -// add a self-managed ARM64 nodegroup -cluster.addAutoScalingGroupCapacity('self-ng-arm', { - instanceType: new ec2.InstanceType('m6g.medium'), - minCapacity: 2, -}) -``` - -### VPC Support - -### Endpoint Access - -When you create a new cluster, Amazon EKS creates an endpoint for the managed Kubernetes API server that you use to communicate with your cluster (using Kubernetes management tools such as `kubectl`) - -By default, this API server endpoint is public to the internet, and access to the API server is secured using a combination of AWS Identity and Access Management (IAM) and native Kubernetes [Role Based Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC). - -You can configure the [cluster endpoint access](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) by using the `endpointAccess` property: - -```typescript -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_16, - endpointAccess: eks.EndpointAccess.PRIVATE // No access outside of your VPC. -}); -``` - -The default value is `eks.EndpointAccess.PUBLIC_AND_PRIVATE`. Which means the cluster endpoint is accessible from outside of your VPC, but worker node traffic and `kubectl` commands issued by this library stay within your VPC. - -### Permissions - -> The IAM role specified in this command is called the "**masters role**". This is -> an IAM role that is associated with the `system:masters` [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) -> group and has super-user access to the cluster. -> -> You can specify this role using the `mastersRole` option, or otherwise a role will be -> automatically created for you. This role can be assumed by anyone in the account with -> `sts:AssumeRole` permissions for this role. - -## Using existing clusters - -You can also directly use the `Nodegroup` construct to create node groups under different scopes: - -```typescript -new eks.Nodegroup(scope, 'NodeGroup', { - cluster: cluster, - ... -}); -``` - -> For a complete API reference visit [`NodegroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupProps.html). - -## Managing Objects - -### Applying - -#### Kubernetes Manifests - -#### Helm Charts - -### Patching - -### Querying - -## Known Issues \ No newline at end of file diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index ab6077a57f667..4a81ce0986e05 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -1,4 +1,615 @@ -### Kubernetes Manifests +## Amazon EKS Construct Library + +--- + +![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) + +> All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use. + +![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.svg?style=for-the-badge) + +> The APIs of higher level constructs in this module are in **developer preview** before they become stable. We will only make breaking changes to address unforeseen API issues. Therefore, these APIs are not subject to [Semantic Versioning](https://semver.org/), and breaking changes will be announced in release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package. + +--- + + +This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. +In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. + +* [Quick Start](#quick-start) +* [Overview](#overview) +* [Provisioning clusters](#provisioning-clusters) + * [Capacity Types](#capacity-types) + * [Managed Node Groups](#1-managed-node-groups) + * [Fargate Profiles](#2-fargate-profiles) + * [Self Managed Auto Scaling Groups](#3-self-managed-auto-scaling-groups) + * [ARM64 Support](#arm64-support) + * [VPC Support](#vpc-support) + * [Endpoint Access](#endpoint-access) + * [Permissions and Access](#permissions-and-access) +* [Managing Kubernetes Resources](#managing-kubernetes-resources) + * [Applying](#applying) + * [Kubernetes Manifests](#kubernetes-manifests) + * [Helm Charts](#helm-charts) + * [Patching](#patching) + * [Querying](#querying) +* [Using existing clusters](#using-existing-clusters) +* [Known Issues](#known-issues) + +## Quick Start + +This example defines an Amazon EKS cluster with the following configuration: + +- Dedicated VPC with default configuration (see [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) +- A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. + +```ts +// provisiong a cluster +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_16, +}); + +// apply a kubernetes manifest to the cluster +cluster.addManifest('mypod', { + apiVersion: 'v1', + kind: 'Pod', + metadata: { name: 'mypod' }, + spec: { + containers: [ + { + name: 'hello', + image: 'paulbouwer/hello-kubernetes:1.5', + ports: [ { containerPort: 8080 } ] + } + ] + } +}); +``` + +In order to interact with your cluster through `kubectl`, you can use the `aws eks update-kubeconfig` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) +to configure your local kubeconfig. The EKS module will define a CloudFormation output in your stack which contains the command to run. For example: + +``` +Outputs: +ClusterConfigCommand43AAE40F = aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy +``` + +Execute the `aws eks update-kubeconfig ... ` command in your terminal to create or update a local kubeconfig context: + +```console +$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy +Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config +``` + +And now you can simply use `kubectl`: + +```console +$ kubectl get all -n kube-system +NAME READY STATUS RESTARTS AGE +pod/aws-node-fpmwv 1/1 Running 0 21m +pod/aws-node-m9htf 1/1 Running 0 21m +pod/coredns-5cb4fb54c7-q222j 1/1 Running 0 23m +pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m +... +``` + +## Architectural Overview + +The following is a qualitative diagram of the various possible components involved in the cluster deployment. + +```text + +-----------------------------------------------+ +-----------------+ + | EKS Cluster | kubectl | | + |-----------------------------------------------|<-------------+| Kubectl Handler | + | | | | + | | +-----------------+ + | +--------------------+ +-----------------+ | + | | | | | | + | | Managed Node Group | | Fargate Profile | | +-----------------+ + | | | | | | | | + | +--------------------+ +-----------------+ | | Cluster Handler | + | | | | + +-----------------------------------------------+ +-----------------+ + ^ ^ + + | | | + | connect self managed capacity | | aws-sdk + | | create/update/delete | + + | v + +--------------------+ + +-------------------+ + | | --------------+| eks.amazonaws.com | + | Auto Scaling Group | +-------------------+ + | | + +--------------------+ +``` + +In a nutshell: + +- `EKS Cluster` - The cluster endpoint created by EKS. +- `Managed Node Group` - EC2 worker nodes managed by EKS. +- `Fargate Profile` - Fargate worker nodes managed by EKS. +- `Auto Scaling Group` - EC2 worker nodes managed by the user. +- `KubectlHandler` - Lambda function for invoking `kubectl` commands on the cluster - created by CDK. +- `ClusterHandler` - Lambda function for interacting with EKS API to manage the cluster lifecycle - created by CDK. + +A more detailed breakdown of each is provided further down this README. + +## Provisioning clusters + +Creating a new cluster is done using the `Cluster` or `FargateCluster` constructs. The only required property is the kubernetes `version`. + +```typescript +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, +}); +``` + +You can also use `FargateCluster` to provision a cluster that uses only fargate workers. + +```typescript +new eks.FargateCluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, +}); +``` + +> **NOTE: Only 1 cluster per stack is supported.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see https://github.com/aws/aws-cdk/issues/10073. + +Below you'll find a few important cluster configuration options. + +### Capacity Types + +Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity, which you can combine as you like: + +#### 1) Managed Node Groups + +Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. +With Amazon EKS managed node groups, you don’t need to separately provision or register the Amazon EC2 instances that provide compute capacity to run your Kubernetes applications. You can create, update, or terminate nodes for your cluster with a single operation. Nodes run using the latest Amazon EKS optimized AMIs in your AWS account while node updates and terminations gracefully drain nodes to ensure that your applications stay available. + +> For more details visit [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). + +**Managed Node Groups are the recommended way to allocate cluster capacity.** + +By default, this library will allocate a managed node group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). + +At cluster instantiation time, you can customize the number of instances and their type: + +```typescript +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + defaultCapacity: 5, + defaultCapacityInstance: ec2.InstanceType.of(ec2.InstanceClass.M5, ec2.InstanceSize.SMALL), +}); +``` + +To access the node group that was created on your behalf, you can use `cluster.defaultNodegroup`. + +Additional customizations are available post instantiation. To apply them, set the default capacity to 0, and use the `cluster.addNodegroupCapacity` method: + +```typescript +const cluster = new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + defaultCapacity: 0, +}); + +cluster.addNodegroupCapacity('custom-node-group', { + instanceType: new ec2.InstanceType('m5.large'), + minSize: 4, + diskSize: 100, + amiType: eks.NodegroupAmiType.AL2_X86_64_GPU, + ... +}); +``` + +> For a complete API reference visit [`NodegroupOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.NodegroupOptions.html). + +##### Launch Template Support + +You can specify a launch template that the node group will use. Note that when using a custom AMI, Amazon EKS doesn't merge any user data. +Rather, You are responsible for supplying the required bootstrap commands for nodes to join the cluster. +In the following example, `/ect/eks/bootstrap.sh` from the AMI will be used to bootstrap the node. + +```ts +const userData = ec2.UserData.forLinux(); +userData.addCommands( + 'set -o xtrace', + `/etc/eks/bootstrap.sh ${cluster.clusterName}`, +); +const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { + launchTemplateData: { + imageId: 'some-ami-id', // custom AMI + instanceType: new ec2.InstanceType('t3.small').toString(), + userData: Fn.base64(userData.render()), + }, +}); +cluster.addNodegroupCapacity('extra-ng', { + launchTemplateSpec: { + id: lt.ref, + version: lt.attrDefaultVersionNumber, + }, +}); +``` + +> For more details visit [Launch Template Support](https://docs.aws.amazon.com/en_ca/eks/latest/userguide/launch-templates.html). + +#### 2) Fargate Profiles + +AWS Fargate is a technology that provides on-demand, right-sized compute +capacity for containers. With AWS Fargate, you no longer have to provision, +configure, or scale groups of virtual machines to run containers. This removes +the need to choose server types, decide when to scale your node groups, or +optimize cluster packing. + +You can control which pods start on Fargate and how they run with Fargate +Profiles, which are defined as part of your Amazon EKS cluster. + +See [Fargate Considerations](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html#fargate-considerations) in the AWS EKS User Guide. + +You can add Fargate Profiles to any EKS cluster defined in your CDK app +through the `addFargateProfile()` method. The following example adds a profile +that will match all pods from the "default" namespace: + +```ts +cluster.addFargateProfile('MyProfile', { + selectors: [ { namespace: 'default' } ] +}); +``` + +> For a complete API reference visit [`FargateProfileOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.FargateProfileOptions.html) + +You can also directly use the `FargateProfile` construct to create profiles under different scopes: + +```ts +new eks.FargateProfile(scope, 'MyProfile', { + cluster, + ... +}); +``` + +> For a complete API reference visit [`FargateProfileProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.FargateProfileProps.html) + +To create an EKS cluster that **only** uses Fargate capacity, you can use `FargateCluster`. +The following code defines an Amazon EKS cluster with a default Fargate Profile that matches all pods from the "kube-system" and "default" namespaces. It is also configured to [run CoreDNS on Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns). + +```ts +const cluster = new eks.FargateCluster(this, 'MyCluster', { + version: eks.KubernetesVersion.V1_16, +}); +``` + +**NOTE**: Classic Load Balancers and Network Load Balancers are not supported on +pods running on Fargate. For ingress, we recommend that you use the [ALB Ingress +Controller](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) +on Amazon EKS (minimum version v1.1.4). + +#### 3) Self Managed Auto Scaling Groups + +Another way of allocating capacity to an EKS cluster is by using self-managed Auto Scaling Groups. +EC2 instances that are part of the auto-scaling group will serve as worker nodes for the cluster. +This type of capacity is also commonly referred to as *EC2 Capacity** or *EC2 Nodes*. + +For a detailed overview please visit [Self Managed Nodes](https://docs.aws.amazon.com/eks/latest/userguide/worker.html). + +These self-managed auto-scaling groups provide some additional capabilities over the managed node group, as detailed below. +However, as they incur an extra maintenance overhead, they are usually not considered a best practice. + +Creating an auto-scaling group and connecting it to the cluster is done using the `cluster.addAutoScalingGroupCapacity` method: + +```ts +cluster.addAutoScalingGroupCapacity('frontend-nodes', { + instanceType: new ec2.InstanceType('t2.medium'), + minCapacity: 3, + vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } +}); +``` + +You can customize the [/etc/eks/boostrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) script, which is responsible +for bootstrapping the node to the EKS cluster. For example, you can use `kubeletExtraArgs` to add custom node labels or taints. + +```ts +cluster.addAutoScalingGroupCapacity('spot', { + instanceType: new ec2.InstanceType('t3.large'), + minCapacity: 2, + bootstrapOptions: { + kubeletExtraArgs: '--node-labels foo=bar,goo=far', + awsApiRetryAttempts: 5 + } +}); +``` + +To disable bootstrapping altogether (i.e. to fully customize user-data), set `bootstrapEnabled` to `false`. + +> For a complete API reference please visit [`AutoScalingGroupCapacityOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.CapacityOptions.html) + +You can also configure the cluster to use an auto-scaling group as the default capacity: + +```ts +cluster = new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + defaultCapacityType: eks.DefaultCapacityType.EC2, +}); +``` + +This will allocate an auto-scaling group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). +To access the `AutoScalingGroup` that was created on your behalf, you can use `cluster.defaultCapacity`. +You can also independently create an `AutoScalingGroup` and connect it to the cluster using the `cluster.connectAutoScalingGroupCapacity` method: + +```ts +const asg = new ec2.AutoScalingGroup(...) +cluster.connectAutoScalingGroupCapacity(asg); +``` + +This will add the necessary user-data and configure all connections, roles, and tags needed for the instances in the auto-scaling group to properly join the cluster. + +##### Spot Instances + +When using self-managed nodes, you can configure the capacity to use spot instances, greatly reducing capacity cost. +To enable spot capacity, use the `spotPrice` property: + +```ts +cluster.addAutoScalingGroupCapacity('spot', { + spotPrice: '0.1094', + instanceType: new ec2.InstanceType('t3.large'), + maxCapacity: 10 +}); +``` + +> Spot instance nodes will be labeled with `lifecycle=Ec2Spot` and tainted with `PreferNoSchedule`. + +The [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) `DaemonSet` will be +installed from [Amazon EKS Helm chart repository](https://github.com/aws/eks-charts/tree/master/stable/aws-node-termination-handler) on these nodes. +The termination handler ensures that the Kubernetes control plane responds appropriately to events that +can cause your EC2 instance to become unavailable, such as [EC2 maintenance events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) +and [EC2 Spot interruptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) and helps gracefully stop all pods running on spot nodes that are about to be +terminated. + +> Handler Version: [1.7.0](https://github.com/aws/aws-node-termination-handler/releases/tag/v1.7.0) +> +> Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) + +##### Bottlerocket + +[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open-source operating system that is purpose-built by Amazon Web Services for running containers on virtual machines or bare metal hosts. +At this moment, `Bottlerocket` is only supported when using self-managed auto-scaling groups. + +> **NOTICE**: Bottlerocket is only available in [some supported AWS regions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/QUICKSTART-EKS.md#finding-an-ami). + +The following example will create an auto-scaling group of 2 `t3.small` Linux instances running with the `Bottlerocket` AMI. + +```ts +cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { + instanceType: new ec2.InstanceType('t3.small'), + minCapacity: 2, + machineImageType: eks.MachineImageType.BOTTLEROCKET +}); +``` + +The specific Bottlerocket AMI variant will be auto selected according to the k8s version for the `x86_64` architecture. +For example, if the Amazon EKS cluster version is `1.17`, the Bottlerocket AMI variant will be auto selected as +`aws-k8s-1.17` behind the scene. + +> See [Variants](https://github.com/bottlerocket-os/bottlerocket/blob/develop/README.md#variants) for more details. + +Please note Bottlerocket does not allow to customize bootstrap options and `bootstrapOptions` properties is not supported when you create the `Bottlerocket` capacity. + +### ARM64 Support + +Instance types with `ARM64` architecture are supported in both managed nodegroup and self-managed capacity. Simply specify an ARM64 `instanceType` (such as `m6g.medium`), and the latest +Amazon Linux 2 AMI for ARM64 will be automatically selected. + +```ts +// add a managed ARM64 nodegroup +cluster.addNodegroupCapacity('extra-ng-arm', { + instanceType: new ec2.InstanceType('m6g.medium'), + minSize: 2, +}); + +// add a self-managed ARM64 nodegroup +cluster.addAutoScalingGroupCapacity('self-ng-arm', { + instanceType: new ec2.InstanceType('m6g.medium'), + minCapacity: 2, +}) +``` + +#### Kubectl Support + +The resources are created in the cluster by running `kubectl apply` from a python lambda function. You can configure the environment of this function by specifying it at cluster instantiation. For example, this can be useful in order to configure an http proxy: + +```typescript +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_16, + kubectlEnvironment: { + 'http_proxy': 'http://proxy.myproxy.com' + } +}); +``` + +By default, the `kubectl`, `helm` and `aws` commands used to operate the cluster are provided by an AWS Lambda Layer from the AWS Serverless Application in [aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl). In most cases this should be sufficient. + +You can provide a custom layer in case the default layer does not meet your +needs or if the SAR app is not available in your region. + +```ts +// custom build: +const layer = new lambda.LayerVersion(this, 'KubectlLayer', { + code: lambda.Code.fromAsset(`${__dirname}/layer.zip`)), + compatibleRuntimes: [lambda.Runtime.PROVIDED] +}); + +// or, a specific version or appid of aws-lambda-layer-kubectl: +const layer = new eks.KubectlLayer(this, 'KubectlLayer', { + version: '2.0.0', // optional + applicationId: '...' // optional +}); +``` + +Pass it to `kubectlLayer` when you create or import a cluster: + +```ts +const cluster = new eks.Cluster(this, 'MyCluster', { + kubectlLayer: layer, +}); + +// or +const cluster = eks.Cluster.fromClusterAttributes(this, 'MyCluster', { + kubectlLayer: layer, +}); +``` + +> Instructions on how to build `layer.zip` can be found +> [here](https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md). + +### VPC Support + +### Encryption + +When you create an Amazon EKS cluster, envelope encryption of Kubernetes secrets using the AWS Key Management Service (AWS KMS) can be enabled. +The documentation on [creating a cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html) +can provide more details about the customer master key (CMK) that can be used for the encryption. + +You can use the `secretsEncryptionKey` to configure which key the cluster will use to encrypt Kubernetes secrets. By default, an AWS Managed key will be used. + +> This setting can only be specified when the cluster is created and cannot be updated. + +```ts +const secretsKey = new kms.Key(this, 'SecretsKey'); +const cluster = new eks.Cluster(this, 'MyCluster', { + secretsEncryptionKey: secretsKey, + // ... +}); +``` + +The Amazon Resource Name (ARN) for that CMK can be retrieved. + +```ts +const clusterEncryptionConfigKeyArn = cluster.clusterEncryptionConfigKeyArn; +``` + +### Permissions and Access + +Amazon EKS provides several mechanism of securing the cluster and granting permissions to specific IAM users and roles. + +#### Endpoint Access + +When you create a new cluster, Amazon EKS creates an endpoint for the managed Kubernetes API server that you use to communicate with your cluster (using Kubernetes management tools such as `kubectl`) + +By default, this API server endpoint is public to the internet, and access to the API server is secured using a combination of +AWS Identity and Access Management (IAM) and native Kubernetes [Role Based Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC). + +You can configure the [cluster endpoint access](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) by using the `endpointAccess` property: + +```typescript +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_16, + endpointAccess: eks.EndpointAccess.PRIVATE // No access outside of your VPC. +}); +``` + +The default value is `eks.EndpointAccess.PUBLIC_AND_PRIVATE`. Which means the cluster endpoint is accessible from outside of your VPC, but worker node traffic and `kubectl` commands issued by this library stay within your VPC. + +#### AWS IAM Mapping + +As described in the [Amazon EKS User Guide](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html), you can map AWS IAM users and roles to [Kubernetes Role-based access control (RBAC)](https://kubernetes.io/docs/reference/access-authn-authz/rbac). + +The Amazon EKS construct manages the *aws-auth* `ConfigMap` Kubernetes resource on your behalf and exposes an API through the `cluster.awsAuth` for mapping +users, roles and accounts. + +Furthermore, when auto-scaling group capacity is added to the cluster, the IAM instance role of the auto-scaling group will be automatically mapped to RBAC so nodes can connect to the cluster. No manual mapping is required. + +For example, let's say you want to grant an IAM user administrative privileges on your cluster: + +```ts +const adminUser = new iam.User(this, 'Admin'); +cluster.awsAuth.addUserMapping(adminUser, { groups: [ 'system:masters' ]}); +``` + +A convenience method for mapping a role to the `system:masters` group is also available: + +```ts +cluster.awsAuth.addMastersRole(role) +``` + +#### Masters Role + +When you create a cluster, you can specify a `mastersRole`. The `Cluster` construct will associate this role with the `system:masters` [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) group, giving it super-user access to the cluster. + +If you do not specify it, a default role will be created on your behalf, that can be assumed by anyone in the account with `sts:AssumeRole` permissions for this role. + +This is the role you see as part of the stack outputs mentioned in the [Quick Start](#quick-start). + +```console +$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy +Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config +``` + +#### Cluster Security Group + +When you create an Amazon EKS cluster, a [cluster security group](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) +is automatically created as well. This security group is designed to allow all traffic from the control plane and managed node groups to flow freely +between each other. + +The ID for that security group can be retrieved after creating the cluster. + +```ts +const clusterSecurityGroupId = cluster.clusterSecurityGroupId; +``` + +#### Node SSH Access + +If you want to be able to SSH into your worker nodes, you must already have an SSH key in the region you're connecting to and pass it when +you add capacity to the cluster. You must also be able to connect to the hosts (meaning they must have a public IP and you +should be allowed to connect to them on port 22): + +See [SSH into nodes](test/example.ssh-into-nodes.lit.ts) for a code example. + +If you want to SSH into nodes in a private subnet, you should set up a bastion host in a public subnet. That setup is recommended, but is +unfortunately beyond the scope of this documentation. + +#### Service Accounts + +With services account you can provide Kubernetes Pods access to AWS resources. + +```ts +// add service account +const sa = cluster.addServiceAccount('MyServiceAccount'); + +const bucket = new Bucket(this, 'Bucket'); +bucket.grantReadWrite(serviceAccount); + +const mypod = cluster.addManifest('mypod', { + apiVersion: 'v1', + kind: 'Pod', + metadata: { name: 'mypod' }, + spec: { + serviceAccountName: sa.serviceAccountName + containers: [ + { + name: 'hello', + image: 'paulbouwer/hello-kubernetes:1.5', + ports: [ { containerPort: 8080 } ], + + } + ] + } +}); + +// create the resource after the service account. +mypod.node.addDependency(sa); + +// print the IAM role arn for this service account +new cdk.CfnOutput(this, 'ServiceAccountIamRole', { value: sa.role.roleArn }) +``` + +Note that using `sa.serviceAccountName` above **does not** translate into a resource dependency. +This is why an explicit dependency is needed. See https://github.com/aws/aws-cdk/issues/9910 for more details. + +## Managing Kubernetes Resources + +In addition to provisioning the clusters themselves, you can also use this library to manage the kubernetes resources inside those clusters. This enables a unified workflow for both your infrastructure and application needs. + +### Applying + +The library supports several popular resource deployment mechanisms, among which are: + +#### Kubernetes Manifests The `KubernetesManifest` construct or `cluster.addManifest` method can be used to apply Kubernetes resource manifests to this cluster. @@ -56,59 +667,7 @@ new KubernetesManifest(this, 'hello-kub', { cluster.addManifest('hello-kub', service, deployment); ``` -#### Kubectl Layer and Environment - -The resources are created in the cluster by running `kubectl apply` from a python lambda function. You can configure the environment of this function by specifying it at cluster instantiation. For example, this can be useful in order to configure an http proxy: - -```typescript -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_16, - kubectlEnvironment: { - 'http_proxy': 'http://proxy.myproxy.com' - } -}); -``` - -By default, the `kubectl`, `helm` and `aws` commands used to operate the cluster -are provided by an AWS Lambda Layer from the AWS Serverless Application -in [aws-lambda-layer-kubectl]. In most cases this should be sufficient. - -You can provide a custom layer in case the default layer does not meet your -needs or if the SAR app is not available in your region. - -```ts -// custom build: -const layer = new lambda.LayerVersion(this, 'KubectlLayer', { - code: lambda.Code.fromAsset(`${__dirname}/layer.zip`)), - compatibleRuntimes: [lambda.Runtime.PROVIDED] -}); - -// or, a specific version or appid of aws-lambda-layer-kubectl: -const layer = new eks.KubectlLayer(this, 'KubectlLayer', { - version: '2.0.0', // optional - applicationId: '...' // optional -}); -``` - -Pass it to `kubectlLayer` when you create or import a cluster: - -```ts -const cluster = new eks.Cluster(this, 'MyCluster', { - kubectlLayer: layer, -}); - -// or -const cluster = eks.Cluster.fromClusterAttributes(this, 'MyCluster', { - kubectlLayer: layer, -}); -``` - -> Instructions on how to build `layer.zip` can be found -> [here](https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md). - -[aws-lambda-layer-kubectl]: https://github.com/aws-samples/aws-lambda-layer-kubectl - -#### Adding resources from a URL +##### Adding resources from a URL The following example will deploy the resource manifest hosting on remote server: @@ -121,16 +680,7 @@ const manifest = yaml.safeLoadAll(request('GET', manifestUrl).getBody()); cluster.addManifest('my-resource', ...manifest); ``` -Since Kubernetes manifests are implemented as CloudFormation resources in the -CDK. This means that if the manifest is deleted from your code (or the stack is -deleted), the next `cdk deploy` will issue a `kubectl delete` command and the -Kubernetes resources in that manifest will be deleted. - -#### Caveat - -If you have multiple resources in a single `KubernetesManifest`, and one of those **resources** is removed from the manifest, it will not be deleted and will remain orphan. See [Support Object pruning](https://github.com/aws/aws-cdk/issues/10495) for more details. - -#### Dependencies +##### Dependencies There are cases where Kubernetes resources must be deployed in a specific order. For example, you cannot define a resource in a Kubernetes namespace before the @@ -162,7 +712,74 @@ or through `cluster.addManifest()`) (e.g. `cluster.addManifest('foo', r1, r2, r3,...)`), these resources will be applied as a single manifest via `kubectl` and will be applied sequentially (the standard behavior in `kubectl`). -### Patching Kubernetes Resources +---------------------- + +Since Kubernetes manifests are implemented as CloudFormation resources in the +CDK. This means that if the manifest is deleted from your code (or the stack is +deleted), the next `cdk deploy` will issue a `kubectl delete` command and the +Kubernetes resources in that manifest will be deleted. + +##### Caveat + +If you have multiple resources in a single `KubernetesManifest`, and one of those **resources** is removed from the manifest, it will not be deleted and will remain orphan. See [Support Object pruning](https://github.com/aws/aws-cdk/issues/10495) for more details. + +#### Helm Charts + +The `HelmChart` construct or `cluster.addHelmChart` method can be used +to add Kubernetes resources to this cluster using Helm. + +> When using `cluster.addHelmChart`, the manifest construct is defined within the cluster's stack scope. If the manifest contains +> attributes from a different stack which depend on the cluster stack, a circular dependency will be created and you will get a synth time error. +> To avoid this, directly use `new HelmChart` to create the chart in the scope of the other stack. + +The following example will install the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/) to your cluster using Helm. + +```ts +// option 1: use a construct +new HelmChart(this, 'NginxIngress', { + cluster, + chart: 'nginx-ingress', + repository: 'https://helm.nginx.com/stable', + namespace: 'kube-system' +}); + +// or, option2: use `addHelmChart` +cluster.addHelmChart('NginxIngress', { + chart: 'nginx-ingress', + repository: 'https://helm.nginx.com/stable', + namespace: 'kube-system' +}); +``` + +> For a complete API reference visit [`HelmChartOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.HelmChartOptions.html) and [`HelmChartProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-eks.HelmChartProps.html). + +Helm charts will be installed and updated using `helm upgrade --install`, where a few parameters +are being passed down (such as `repo`, `values`, `version`, `namespace`, `wait`, `timeout`, etc). +This means that if the chart is added to CDK with the same release name, it will try to update +the chart in the cluster. + +Helm charts are implemented as CloudFormation resources in CDK. +This means that if the chart is deleted from your code (or the stack is +deleted), the next `cdk deploy` will issue a `helm uninstall` command and the +Helm chart will be deleted. + +When there is no `release` defined, the chart will be installed using the `node.uniqueId`, +which will be lower cased and truncated to the last 63 characters. + +By default, all Helm charts will be installed concurrently. In some cases, this +could cause race conditions where two Helm charts attempt to deploy the same +resource or if Helm charts depend on each other. You can use +`chart.node.addDependency()` in order to declare a dependency order between +charts: + +```ts +const chart1 = cluster.addHelmChart(...); +const chart2 = cluster.addHelmChart(...); + +chart2.node.addDependency(chart1); +``` + +### Patching The `KubernetesPatch` construct can be used to update existing kubernetes resources. The following example can be used to patch the `hello-kubernetes` @@ -177,7 +794,7 @@ new KubernetesPatch(this, 'hello-kub-deployment-label', { }) ``` -### Querying Kubernetes Object Values +### Querying The `KubernetesObjectValue` construct can be used to query for information about kubernetes objects, and use that as part of your CDK application. @@ -208,7 +825,7 @@ Specifically, since the above use-case is quite common, there is an easier way t const loadBalancerAddress = cluster.getServiceLoadBalancerAddress('my-service'); ``` -### Kubernetes Resources in Existing Clusters +## Using existing clusters The Amazon EKS library allows defining Kubernetes resources such as [Kubernetes manifests](#kubernetes-resources) and [Helm charts](#helm-charts) on clusters @@ -261,174 +878,26 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: - `kubectlPrivateSubnetIds` - a list of private VPC subnets IDs that will be used to access the Kubernetes endpoint. -### AWS IAM Mapping - -As described in the [Amazon EKS User Guide](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html), -you can map AWS IAM users and roles to [Kubernetes Role-based access control (RBAC)](https://kubernetes.io/docs/reference/access-authn-authz/rbac). - -The Amazon EKS construct manages the **aws-auth ConfigMap** Kubernetes resource -on your behalf and exposes an API through the `cluster.awsAuth` for mapping -users, roles and accounts. - -Furthermore, when auto-scaling capacity is added to the cluster (through -`cluster.addAutoScalingGroupCapacity` or `cluster.addAutoScalingGroup`), the IAM instance role -of the auto-scaling group will be automatically mapped to RBAC so nodes can -connect to the cluster. No manual mapping is required. +## Known Issues and Limitations -For example, let's say you want to grant an IAM user administrative privileges -on your cluster: +- [One cluster per stack](). +- [Object pruning](). +- [Service Account dependencies](). -```ts -const adminUser = new iam.User(this, 'Admin'); -cluster.awsAuth.addUserMapping(adminUser, { groups: [ 'system:masters' ]}); -``` - -A convenience method for mapping a role to the `system:masters` group is also available: - -```ts -cluster.awsAuth.addMastersRole(role) -``` - -### Cluster Security Group - -When you create an Amazon EKS cluster, a -[cluster security group](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) -is automatically created as well. This security group is designed to allow -all traffic from the control plane and managed node groups to flow freely -between each other. - -The ID for that security group can be retrieved after creating the cluster. - -```ts -const clusterSecurityGroupId = cluster.clusterSecurityGroupId; -``` - -### Cluster Encryption Configuration - -When you create an Amazon EKS cluster, envelope encryption of -Kubernetes secrets using the AWS Key Management Service (AWS KMS) can be enabled. The documentation -on [creating a cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html) -can provide more details about the customer master key (CMK) that can be used for the encryption. - -You can use the `secretsEncryptionKey` to configure which key the cluster will use to encrypt Kubernetes secrets. By default, an AWS Managed key will be used. - -> This setting can only be specified when the cluster is created and cannot be updated. - - -```ts -const secretsKey = new kms.Key(this, 'SecretsKey'); -const cluster = new eks.Cluster(this, 'MyCluster', { - secretsEncryptionKey: secretsKey, - // ... -}); -``` - -The Amazon Resource Name (ARN) for that CMK can be retrieved. - -```ts -const clusterEncryptionConfigKeyArn = cluster.clusterEncryptionConfigKeyArn; -``` - -### Node ssh Access - -If you want to be able to SSH into your worker nodes, you must already -have an SSH key in the region you're connecting to and pass it when you add capacity to the cluster. You must also be able to connect to the hosts (meaning they must have a public IP and you -should be allowed to connect to them on port 22): - -See [SSH into nodes](test/example.ssh-into-nodes.lit.ts) for a code example. - -If you want to SSH into nodes in a private subnet, you should set up a -bastion host in a public subnet. That setup is recommended, but is -unfortunately beyond the scope of this documentation. - -### Helm Charts - -The `HelmChart` construct or `cluster.addHelmChart` method can be used -to add Kubernetes resources to this cluster using Helm. - -> When using `cluster.addHelmChart`, the manifest construct is defined within the cluster's stack scope. If the manifest contains -> attributes from a different stack which depend on the cluster stack, a circular dependency will be created and you will get a synth time error. -> To avoid this, directly use `new HelmChart` to create the chart in the scope of the other stack. - -The following example will install the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/) -to your cluster using Helm. - -```ts -// option 1: use a construct -new HelmChart(this, 'NginxIngress', { - cluster, - chart: 'nginx-ingress', - repository: 'https://helm.nginx.com/stable', - namespace: 'kube-system' -}); - -// or, option2: use `addHelmChart` -cluster.addHelmChart('NginxIngress', { - chart: 'nginx-ingress', - repository: 'https://helm.nginx.com/stable', - namespace: 'kube-system' -}); -``` - -Helm charts will be installed and updated using `helm upgrade --install`, where a few parameters -are being passed down (such as `repo`, `values`, `version`, `namespace`, `wait`, `timeout`, etc). -This means that if the chart is added to CDK with the same release name, it will try to update -the chart in the cluster. - -Helm charts are implemented as CloudFormation resources in CDK. -This means that if the chart is deleted from your code (or the stack is -deleted), the next `cdk deploy` will issue a `helm uninstall` command and the -Helm chart will be deleted. - -When there is no `release` defined, the chart will be installed using the `node.uniqueId`, -which will be lower cased and truncated to the last 63 characters. - -By default, all Helm charts will be installed concurrently. In some cases, this -could cause race conditions where two Helm charts attempt to deploy the same -resource or if Helm charts depend on each other. You can use -`chart.node.addDependency()` in order to declare a dependency order between -charts: - -```ts -const chart1 = cluster.addHelmChart(...); -const chart2 = cluster.addHelmChart(...); - -chart2.node.addDependency(chart1); -``` - -### Service Accounts - -With services account you can provide Kubernetes Pods access to AWS resources. - -```ts -// add service account -const sa = cluster.addServiceAccount('MyServiceAccount'); +## RoadMap -const bucket = new Bucket(this, 'Bucket'); -bucket.grantReadWrite(serviceAccount); +We manage the road map via a GitHub project: [EKS Construct Library](https://github.com/aws/aws-cdk/projects/4). The columns in the board are as follows: -const mypod = cluster.addManifest('mypod', { - apiVersion: 'v1', - kind: 'Pod', - metadata: { name: 'mypod' }, - spec: { - serviceAccountName: sa.serviceAccountName - containers: [ - { - name: 'hello', - image: 'paulbouwer/hello-kubernetes:1.5', - ports: [ { containerPort: 8080 } ], +- *Needs Triage*: Issue has been submitted but needs triage to determine validity. +- *To Do*: Issue has been accepted and assigned labels. +- *Planned*: Issue is planned for implementation. You won't find any concrete dates here, but it usually reflects a quarterly timeline. +- *In Progress**: Issue is actively being worked on. +- *Review*: Issue has a PR submitted and is under review. +- *Done*: Issue has been implemented and is either released or will be released in the next version. - } - ] - } -}); +In addition, we sometimes track long standing projects using GitHub milestones: -// create the resource after the service account. -// note that using `sa.serviceAccountName` above **does not** translate into a dependency. -// this is why an explicit dependency is needed. See https://github.com/aws/aws-cdk/issues/9910 for more details. -mypod.node.addDependency(sa); +- [EKS Developer Preview](https://github.com/aws/aws-cdk/milestone/6) +- [CDK8s Integration](https://github.com/aws/aws-cdk/milestone/8) -// print the IAM role arn for this service account -new cdk.CfnOutput(this, 'ServiceAccountIamRole', { value: sa.role.roleArn }) -``` \ No newline at end of file +You can navigate to these milestone to quickly understand the status of each project. \ No newline at end of file From 2e23a1ddfee7d12685cc7c535bb06fac7d4ad62d Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 19:14:31 +0300 Subject: [PATCH 18/36] mid work --- packages/@aws-cdk/aws-eks/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 4a81ce0986e05..3e5fa92aca2d2 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -24,6 +24,7 @@ In addition, the library also supports defining Kubernetes resource manifests wi * [Fargate Profiles](#2-fargate-profiles) * [Self Managed Auto Scaling Groups](#3-self-managed-auto-scaling-groups) * [ARM64 Support](#arm64-support) + * [Kubectl Support](#kubectl-support) * [VPC Support](#vpc-support) * [Endpoint Access](#endpoint-access) * [Permissions and Access](#permissions-and-access) From 43960011e479f9cfb70c93cbb08f8d57eee7f437 Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 20:33:27 +0300 Subject: [PATCH 19/36] mid work --- packages/@aws-cdk/aws-eks/README.md | 43 ++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 3e5fa92aca2d2..45abd9c547566 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -460,6 +460,46 @@ const cluster = eks.Cluster.fromClusterAttributes(this, 'MyCluster', { ### VPC Support +You can specify the VPC of the cluster using the `vpc` and `vpcSubnets` properties: + +```ts +const vpc = new ec2.Vpc(this, 'Vpc'); + +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_17, + vpc, + vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE }] +}); +``` + +If you do not specify a VPC, one will be created on your behalf, which you can then access via `cluster.vpc`. The cluster VPC will be associated to any EKS managed capacity (i.e Managed Node Groups and Fargate Profiles). + +If you allocate self managed capacity, you can specify which subnets should the auto-scaling group use: + +```ts +const vpc = new ec2.Vpc(this, 'Vpc'); +cluster.addAutoScalingGroupCapacity('nodes', { + vpcSubnets: { subnets: vpc.privateSubnets } +}); +``` + +In addition to the cluster and the capacity, there are two additional components you might want to +provision within a VPC. + +#### Kubectl Handler + +The `KubectlHandler` is a Lambda function responsible to issuing `kubectl` and `helm` commands against the cluster when you add resource manifests to the cluster. + +The handler association to the VPC is derived from the `endpointAccess` configuration. The rule of thumb is: *If the cluster VPC can be associated, it will be*. + +Breaking this down, it means that if the endpoint exposes private access (via `EndpointAccess.PRIVATE` or `EndpointAccess.PUBLIC_AND_PRIVATE`), and the VPC contains **private** subnets, the Lambda function will be provisioned inside the VPC and use the private subnets to interact with the cluster. This is the common use-case. + +If the endpoint does not expose private access (via `EndpointAccess.PUBLIC`) **or** the VPC does not contain private subnets, the function will not be provisioned within the VPC. + +#### Cluster Handler + +The `ClusterHandler` is a Lambda function responsible to interact the EKS API in order to control the cluster lifecycle. At the moment, this function cannot be provisioned inside the VPC. See [Attach all Lambda Function to a VPC](https://github.com/aws/aws-cdk/issues/9509) for more details. + ### Encryption When you create an Amazon EKS cluster, envelope encryption of Kubernetes secrets using the AWS Key Management Service (AWS KMS) can be enabled. @@ -884,6 +924,7 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: - [One cluster per stack](). - [Object pruning](). - [Service Account dependencies](). +- [Cluster Handler VPC](). ## RoadMap @@ -892,7 +933,7 @@ We manage the road map via a GitHub project: [EKS Construct Library](https://git - *Needs Triage*: Issue has been submitted but needs triage to determine validity. - *To Do*: Issue has been accepted and assigned labels. - *Planned*: Issue is planned for implementation. You won't find any concrete dates here, but it usually reflects a quarterly timeline. -- *In Progress**: Issue is actively being worked on. +- *In Progress*: Issue is actively being worked on. - *Review*: Issue has a PR submitted and is under review. - *Done*: Issue has been implemented and is either released or will be released in the next version. From 55dbfad9b14590427d029bdd9c415037b01c92fd Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 20:35:49 +0300 Subject: [PATCH 20/36] mid work --- packages/@aws-cdk/aws-eks/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 45abd9c547566..a26d80c6a035f 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -921,10 +921,10 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: ## Known Issues and Limitations -- [One cluster per stack](). -- [Object pruning](). -- [Service Account dependencies](). -- [Cluster Handler VPC](). +- [One cluster per stack](https://github.com/aws/aws-cdk/issues/10073) +- [Object pruning](https://github.com/aws/aws-cdk/issues/10495) +- [Service Account dependencies](https://github.com/aws/aws-cdk/issues/9910) +- [Attach all Lambda Functions to VPC](https://github.com/aws/aws-cdk/issues/9509) ## RoadMap From aae727490140729ccde0b1e88d3a4471f85bbab1 Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 22:59:34 +0300 Subject: [PATCH 21/36] mid work --- packages/@aws-cdk/aws-eks/README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index a26d80c6a035f..905d0231ade00 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -17,7 +17,7 @@ This construct library allows you to define [Amazon Elastic Container Service fo In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. * [Quick Start](#quick-start) -* [Overview](#overview) +* [Architectural Overview](#architectural-overview) * [Provisioning clusters](#provisioning-clusters) * [Capacity Types](#capacity-types) * [Managed Node Groups](#1-managed-node-groups) @@ -26,14 +26,13 @@ In addition, the library also supports defining Kubernetes resource manifests wi * [ARM64 Support](#arm64-support) * [Kubectl Support](#kubectl-support) * [VPC Support](#vpc-support) - * [Endpoint Access](#endpoint-access) * [Permissions and Access](#permissions-and-access) * [Managing Kubernetes Resources](#managing-kubernetes-resources) - * [Applying](#applying) + * [Applying Resources](#applying-resources) * [Kubernetes Manifests](#kubernetes-manifests) * [Helm Charts](#helm-charts) - * [Patching](#patching) - * [Querying](#querying) + * [Patching Resources](#patching-resources) + * [Querying Resources](#querying-resources) * [Using existing clusters](#using-existing-clusters) * [Known Issues](#known-issues) @@ -646,7 +645,7 @@ This is why an explicit dependency is needed. See https://github.com/aws/aws-cdk In addition to provisioning the clusters themselves, you can also use this library to manage the kubernetes resources inside those clusters. This enables a unified workflow for both your infrastructure and application needs. -### Applying +### Applying Resources The library supports several popular resource deployment mechanisms, among which are: @@ -820,7 +819,7 @@ const chart2 = cluster.addHelmChart(...); chart2.node.addDependency(chart1); ``` -### Patching +### Patching Resources The `KubernetesPatch` construct can be used to update existing kubernetes resources. The following example can be used to patch the `hello-kubernetes` @@ -835,7 +834,7 @@ new KubernetesPatch(this, 'hello-kub-deployment-label', { }) ``` -### Querying +### Querying Resources The `KubernetesObjectValue` construct can be used to query for information about kubernetes objects, and use that as part of your CDK application. From 14fa8784196f03d9bc2181bddfa3534adc3809c0 Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 23:00:13 +0300 Subject: [PATCH 22/36] refactor --- packages/@aws-cdk/aws-eks/lib/cluster.ts | 4 ++-- packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/lib/cluster.ts b/packages/@aws-cdk/aws-eks/lib/cluster.ts index 9693bac1c6c33..979e863372ec8 100644 --- a/packages/@aws-cdk/aws-eks/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/cluster.ts @@ -1036,7 +1036,7 @@ export class Cluster extends ClusterBase { * daemon will be installed on all spot instances to handle * [EC2 Spot Instance Termination Notices](https://aws.amazon.com/blogs/aws/new-ec2-spot-instance-termination-notices/). */ - public addAutoScalingGroupCapacity(id: string, options: CapacityOptions): autoscaling.AutoScalingGroup { + public addAutoScalingGroupCapacity(id: string, options: AutoScalingGroupCapacityOptions): autoscaling.AutoScalingGroup { if (options.machineImageType === MachineImageType.BOTTLEROCKET && options.bootstrapOptions !== undefined ) { throw new Error('bootstrapOptions is not supported for Bottlerocket'); } @@ -1430,7 +1430,7 @@ export class Cluster extends ClusterBase { /** * Options for adding worker nodes */ -export interface CapacityOptions extends autoscaling.CommonAutoScalingGroupProps { +export interface AutoScalingGroupCapacityOptions extends autoscaling.CommonAutoScalingGroupProps { /** * Instance type of the instances to start */ diff --git a/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts b/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts index 5d7f46d6d94b0..840f4f0c1ec6d 100644 --- a/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/legacy-cluster.ts @@ -4,7 +4,7 @@ import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import * as ssm from '@aws-cdk/aws-ssm'; import { Annotations, CfnOutput, Construct, Resource, Stack, Token, Tags } from '@aws-cdk/core'; -import { ICluster, ClusterAttributes, KubernetesVersion, NodeType, DefaultCapacityType, EksOptimizedImage, CapacityOptions, MachineImageType, AutoScalingGroupOptions, CommonClusterOptions } from './cluster'; +import { ICluster, ClusterAttributes, KubernetesVersion, NodeType, DefaultCapacityType, EksOptimizedImage, AutoScalingGroupCapacityOptions, MachineImageType, AutoScalingGroupOptions, CommonClusterOptions } from './cluster'; import { clusterArnComponents } from './cluster-resource'; import { CfnCluster, CfnClusterProps } from './eks.generated'; import { HelmChartOptions, HelmChart } from './helm-chart'; @@ -251,7 +251,7 @@ export class LegacyCluster extends Resource implements ICluster { * * Spot instances will be labeled `lifecycle=Ec2Spot` and tainted with `PreferNoSchedule`. */ - public addCapacity(id: string, options: CapacityOptions): autoscaling.AutoScalingGroup { + public addCapacity(id: string, options: AutoScalingGroupCapacityOptions): autoscaling.AutoScalingGroup { if (options.machineImageType === MachineImageType.BOTTLEROCKET && options.bootstrapOptions !== undefined ) { throw new Error('bootstrapOptions is not supported for Bottlerocket'); } From 37bb76a1e9fde8e501a8f7759602495d81956b3d Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 28 Sep 2020 23:03:57 +0300 Subject: [PATCH 23/36] refactor --- packages/@aws-cdk/aws-eks/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 905d0231ade00..5fe9b0053e759 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -34,7 +34,8 @@ In addition, the library also supports defining Kubernetes resource manifests wi * [Patching Resources](#patching-resources) * [Querying Resources](#querying-resources) * [Using existing clusters](#using-existing-clusters) -* [Known Issues](#known-issues) +* [Known Issues and Limitations](#known-issues-and-limitations) +* [RoadMap](#roadmap) ## Quick Start @@ -409,7 +410,7 @@ cluster.addAutoScalingGroupCapacity('self-ng-arm', { }) ``` -#### Kubectl Support +### Kubectl Support The resources are created in the cluster by running `kubectl apply` from a python lambda function. You can configure the environment of this function by specifying it at cluster instantiation. For example, this can be useful in order to configure an http proxy: From c9da14279d4cdc911084e24b458442a98974279a Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 29 Sep 2020 00:07:18 +0300 Subject: [PATCH 24/36] added cdk8s docs --- packages/@aws-cdk/aws-eks/README.md | 71 +++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 5fe9b0053e759..97235bc764071 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -31,6 +31,7 @@ In addition, the library also supports defining Kubernetes resource manifests wi * [Applying Resources](#applying-resources) * [Kubernetes Manifests](#kubernetes-manifests) * [Helm Charts](#helm-charts) + * [CDK8s Charts](#cdk8s-charts) * [Patching Resources](#patching-resources) * [Querying Resources](#querying-resources) * [Using existing clusters](#using-existing-clusters) @@ -820,6 +821,76 @@ const chart2 = cluster.addHelmChart(...); chart2.node.addDependency(chart1); ``` +#### CDK8s Charts + +[CDK8s](https://cdk8s.io/) is an open-source library that enables Kubernetes manifest authoring using familiar programming languages. It is founded on the same technologies as the AWS CDK such as [`constructs`](https://github.com/aws/constructs) and [`jsii`](https://github.com/aws/jsii). + +> To learn more about cdk8s, visit the [Getting Started](https://github.com/awslabs/cdk8s/tree/master/docs/getting-started) tutorials. + +The EKS module natively integrates with cdk8s and allows you to apply cdk8s charts on AWS EKS clusters via the `cluster.addCdk8sChart` method. + +To get started, add the `cdk8s` dependency to your `package.json` file. + +```json +dependencies: { + "cdk8s": "^0.29.0" +} +``` + +Next, install the `cdk8s-cli`: + +```console +npm install -g cdk8s-cli +``` + +The CLI is only used to import the core kubernetes api objects, and is not necessarily required as a runtime dependency. In your project directory, run the following command: + +```console +cdk8s import k8s@{kubernetes-cluster-version} -l typescript +``` + +This will create an `imports` directory that contains the entire k8s object API as constructs. +We recommend you commit this directory as part of your source code. + +Now, in your application code: + +```ts +import * as eks from '@aws-cdk/aws-eks'; +import * as cdk8s from 'cdk8s'; +import * as k8s from './imports/k8s'; + +const cluster = new eks.Cluster(this, 'HelloCDK8s', { + version: eks.KubernetesVersion.V1_17, +}); + +// create a cdk8s app +const cdk8sApp = new cdk8s.App(); + +// create a cdk8s chart +const proxy = new cdk8s.Chart(cdk8sApp, 'ProxyChart'); + +// create a pod using strongly typed k8s api. +new k8s.Pod(proxy, 'Pod', { + spec: { + containers: [{ + name: 'nginx', + image: 'nginx', + }], + }, +}); + +// add the cdk8s chart to the cluster +cluster.addCdk8sChart('proxy', proxy); +``` + +Note that at this moment, you cannot use AWS CDK constructs as scopes for CDK8s constructs. +That is, make sure that the cdk8s chart (`proxy` in our case) is an ancestor of every cdk8s construct you define. + +In addition to `cdk8s`, you can also use a library called [`cdk8s+`](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-plus). It is build on top of `cdk8s` and provide higher level abstraction for the core kubernetes api objects. +You can think of it like the `L2` constructs for Kubernetes. + +To learn more about it, checkout this [example](https://github.com/awslabs/cdk8s/tree/master/examples/typescript/cdk8s-plus-elasticsearch-query) and blog post: [Introducing cdk8s+: Intent-driven APIs for Kubernetes objects](https://aws.amazon.com/blogs/containers/introducing-cdk8s-intent-driven-apis-for-kubernetes-objects/) + ### Patching Resources The `KubernetesPatch` construct can be used to update existing kubernetes From 9d9a3bb3e9aa74c15d34306a6d8d5d9b76f2bfdb Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 29 Sep 2020 00:20:37 +0300 Subject: [PATCH 25/36] mid work --- packages/@aws-cdk/aws-eks/README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 97235bc764071..680b410191653 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -849,10 +849,15 @@ The CLI is only used to import the core kubernetes api objects, and is not neces cdk8s import k8s@{kubernetes-cluster-version} -l typescript ``` -This will create an `imports` directory that contains the entire k8s object API as constructs. -We recommend you commit this directory as part of your source code. +For example, for `eks.KubernetesVersion.V1_17` you would run: -Now, in your application code: +```console +cdk8s import k8s@1.17.0 -l typescript +``` + +This will create an `imports` directory that contains the entire k8s object API, as typescript constructs. We recommend you commit this directory as part of your source code. + +In your application code: ```ts import * as eks from '@aws-cdk/aws-eks'; @@ -886,7 +891,7 @@ cluster.addCdk8sChart('proxy', proxy); Note that at this moment, you cannot use AWS CDK constructs as scopes for CDK8s constructs. That is, make sure that the cdk8s chart (`proxy` in our case) is an ancestor of every cdk8s construct you define. -In addition to `cdk8s`, you can also use a library called [`cdk8s+`](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-plus). It is build on top of `cdk8s` and provide higher level abstraction for the core kubernetes api objects. +In addition to `cdk8s`, you can also use [`cdk8s+`](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-plus), which is also part of the cdk8s toolchain, and is built on top of the core `cdk8s` API. It provides higher level abstraction for kubernetes api objects. You can think of it like the `L2` constructs for Kubernetes. To learn more about it, checkout this [example](https://github.com/awslabs/cdk8s/tree/master/examples/typescript/cdk8s-plus-elasticsearch-query) and blog post: [Introducing cdk8s+: Intent-driven APIs for Kubernetes objects](https://aws.amazon.com/blogs/containers/introducing-cdk8s-intent-driven-apis-for-kubernetes-objects/) From 1c100b97bd5da30aa36c8ed6a4abee99e4f51370 Mon Sep 17 00:00:00 2001 From: epolon Date: Wed, 30 Sep 2020 12:14:45 +0300 Subject: [PATCH 26/36] added cdk8s version requirement --- packages/@aws-cdk/aws-eks/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index cbdbc70c4b7c9..163d2b64c8fcb 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -828,6 +828,8 @@ dependencies: { } ``` +> Note that the version of `cdk8s` must be `>=0.29.0`. + Next, install the `cdk8s-cli`: ```console From 9fabc395f5aea792aee9c3ae26685377b360caf6 Mon Sep 17 00:00:00 2001 From: epolon Date: Thu, 1 Oct 2020 21:42:02 +0300 Subject: [PATCH 27/36] extend cdk8s chart in integ test --- .../aws-eks/test/integ.eks-cluster.ts | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts index 7355d05170d1a..497905a712fb3 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts @@ -4,6 +4,7 @@ import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import { App, CfnOutput, Duration, Token, Fn } from '@aws-cdk/core'; import * as cdk8s from 'cdk8s'; +import * as constructs from 'constructs'; import * as eks from '../lib'; import * as hello from './hello-k8s'; import * as k8s from './imports/k8s-v1_17_0'; @@ -107,14 +108,21 @@ class EksClusterStack extends TestStack { } private assertSimpleCdk8sChart() { - const app = new cdk8s.App(); - const chart = new cdk8s.Chart(app, 'Chart'); - new k8s.ConfigMap(chart, 'config-map', { - data: { - clusterName: this.cluster.clusterName, - }, - }); + class Chart extends cdk8s.Chart { + constructor(scope: constructs.Construct, ns: string, cluster: eks.ICluster) { + super(scope, ns); + + new k8s.ConfigMap(this, 'config-map', { + data: { + clusterName: cluster.clusterName, + }, + }); + + } + } + const app = new cdk8s.App(); + const chart = new Chart(app, 'Chart', this.cluster); this.cluster.addCdk8sChart('cdk8s-chart', chart); } From 127f60c0d0cc4575bab11a3fcdf294cd63c20c73 Mon Sep 17 00:00:00 2001 From: epolon Date: Fri, 2 Oct 2020 18:10:07 +0300 Subject: [PATCH 28/36] use cdk8s-plus --- packages/@aws-cdk/aws-eks/README.md | 94 +- packages/@aws-cdk/aws-eks/package.json | 3 +- .../aws-eks/test/imports/k8s-v1_17_0.ts | 13982 ---------------- .../aws-eks/test/integ.eks-cluster.ts | 4 +- 4 files changed, 62 insertions(+), 14021 deletions(-) delete mode 100644 packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 163d2b64c8fcb..627e42c8901d1 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -820,75 +820,97 @@ chart2.node.addDependency(chart1); The EKS module natively integrates with cdk8s and allows you to apply cdk8s charts on AWS EKS clusters via the `cluster.addCdk8sChart` method. -To get started, add the `cdk8s` dependency to your `package.json` file. +In addition to `cdk8s`, you can also use [`cdk8s+`](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-plus), which provides higher level abstraction for the core kubernetes api objects. +You can think of it like the `L2` constructs for Kubernetes. + +To get started, add the following dependencies to your `package.json` file: ```json dependencies: { - "cdk8s": "^0.29.0" + "cdk8s": "0.29.0", + "cdk8s-plus": "0.29.0", + "constructs": "3.0.4", } ``` > Note that the version of `cdk8s` must be `>=0.29.0`. -Next, install the `cdk8s-cli`: +We recommend seperate the `cdk8s` charts to a different file and extend the `cdk8s.Chart` class. +Notice that `cdk8s` uses the `Construct` class from the [`constructs`](https://github.com/aws/constructs) module, not from `@aws-cdk/core`. -```console -npm install -g cdk8s-cli -``` +You can freely pass cdk constructs to it and use any of its properties and attributes. -The CLI is only used to import the core kubernetes api objects, and is not necessarily required as a runtime dependency. In your project directory, run the following command: +In this example we create a chart that accepts an `s3.IBucket` and passes its name to a kubernetes pod as an environment variable. -```console -cdk8s import k8s@{kubernetes-cluster-version} -l typescript -``` +```ts +import * as s3 from '@aws-cdk/aws-s3'; +import * as constructs from 'constructs'; +import * as cdk8s from 'cdk8s'; +import * as kplus from 'cdk8s-plus'; -For example, for `eks.KubernetesVersion.V1_17` you would run: +export interface MyChartProps { -```console -cdk8s import k8s@1.17.0 -l typescript -``` + readonly bucket: s3.IBucket; +} + +export class MyChart extends cdk8s.Chart { + constructor(scope: constructs.Construct, id: string, props: MyChartProps} ) { + super(scope, id); + + new kplus.Pod(this, 'Pod', { + spec: { + containers: [ + new kplus.Container({ + image: 'my-image', + env: { + BUCKET_NAME: bucket.bucketName, + } + }) + ] + } + }); -This will create an `imports` directory that contains the entire k8s object API, as typescript constructs. We recommend you commit this directory as part of your source code. + } +} +``` -In your application code: +Then, in your cdk app: ```ts import * as eks from '@aws-cdk/aws-eks'; +import * as s3 from '@aws-cdk/aws-s3'; import * as cdk8s from 'cdk8s'; -import * as k8s from './imports/k8s'; +import { MyChart } from './my-chart' const cluster = new eks.Cluster(this, 'HelloCDK8s', { version: eks.KubernetesVersion.V1_17, }); -// create a cdk8s app -const cdk8sApp = new cdk8s.App(); - -// create a cdk8s chart -const proxy = new cdk8s.Chart(cdk8sApp, 'ProxyChart'); +// some bucket.. +const bucket = new s3.Bucket(this, 'Bucket'); -// create a pod using strongly typed k8s api. -new k8s.Pod(proxy, 'Pod', { - spec: { - containers: [{ - name: 'nginx', - image: 'nginx', - }], - }, -}); +// create a cdk8s chart. +const myChart = new MyChart(new cdk8s.App(), 'MyChart', { bucket }); // add the cdk8s chart to the cluster -cluster.addCdk8sChart('proxy', proxy); +cluster.addCdk8sChart('my-chart', myChart); ``` Note that at this moment, you cannot use AWS CDK constructs as scopes for CDK8s constructs. -That is, make sure that the cdk8s chart (`proxy` in our case) is an ancestor of every cdk8s construct you define. +This is why we use `new cdk8s.App()` as the scope of the chart itself. -In addition to `cdk8s`, you can also use [`cdk8s+`](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-plus), which is also part of the cdk8s toolchain, and is built on top of the core `cdk8s` API. It provides higher level abstraction for kubernetes api objects. -You can think of it like the `L2` constructs for Kubernetes. +##### Caveat + +`cdk8s+` is vended with a static version of the kubernetes API spec. See ... + +At the moment, there is no way to control which spec version `cdk8s+` uses, so if you need other versions, please refer to [Manual importing](#manually-importing-k8s-specs-and-crds) below. +This would unfortunately mean you won't be able to utilize `cdk8s+` capabilities. + +##### Manually importing k8s specs and CRD's -To learn more about it, checkout this [example](https://github.com/awslabs/cdk8s/tree/master/examples/typescript/cdk8s-plus-elasticsearch-query) and blog post: [Introducing cdk8s+: Intent-driven APIs for Kubernetes objects](https://aws.amazon.com/blogs/containers/introducing-cdk8s-intent-driven-apis-for-kubernetes-objects/) +If you find yourself unable to use `cdk8s+`, or just like to directly use the `k8s` native objects or CRD's, you can do so by manually importing them using the `cdk8s-cli`. +See [Importing kubernetes objects](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-cli#import) for detailed instructions. ## Patching Kubernetes Resources diff --git a/packages/@aws-cdk/aws-eks/package.json b/packages/@aws-cdk/aws-eks/package.json index 5386c5d65f4a7..309d4a50526d3 100644 --- a/packages/@aws-cdk/aws-eks/package.json +++ b/packages/@aws-cdk/aws-eks/package.json @@ -76,7 +76,8 @@ "cfn2ts": "0.0.0", "nodeunit": "^0.11.3", "pkglint": "0.0.0", - "sinon": "^9.0.3" + "sinon": "^9.0.3", + "cdk8s-plus": "^0.29.0" }, "dependencies": { "@aws-cdk/aws-autoscaling": "0.0.0", diff --git a/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts b/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts deleted file mode 100644 index e1bfdd603cd14..0000000000000 --- a/packages/@aws-cdk/aws-eks/test/imports/k8s-v1_17_0.ts +++ /dev/null @@ -1,13982 +0,0 @@ -// generated by cdk8s -import { ApiObject } from 'cdk8s'; -import { Construct } from 'constructs'; - -/** - * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration - */ -export class MutatingWebhookConfiguration extends ApiObject { - /** - * Defines a "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: MutatingWebhookConfigurationOptions = {}) { - super(scope, name, { - ...options, - kind: 'MutatingWebhookConfiguration', - apiVersion: 'admissionregistration.k8s.io/v1', - }); - } -} - -/** - * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList - */ -export class MutatingWebhookConfigurationList extends ApiObject { - /** - * Defines a "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: MutatingWebhookConfigurationListOptions) { - super(scope, name, { - ...options, - kind: 'MutatingWebhookConfigurationList', - apiVersion: 'admissionregistration.k8s.io/v1', - }); - } -} - -/** - * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration - */ -export class ValidatingWebhookConfiguration extends ApiObject { - /** - * Defines a "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ValidatingWebhookConfigurationOptions = {}) { - super(scope, name, { - ...options, - kind: 'ValidatingWebhookConfiguration', - apiVersion: 'admissionregistration.k8s.io/v1', - }); - } -} - -/** - * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList - */ -export class ValidatingWebhookConfigurationList extends ApiObject { - /** - * Defines a "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ValidatingWebhookConfigurationListOptions) { - super(scope, name, { - ...options, - kind: 'ValidatingWebhookConfigurationList', - apiVersion: 'admissionregistration.k8s.io/v1', - }); - } -} - -/** - * ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. - * - * @schema io.k8s.api.apps.v1.ControllerRevision - */ -export class ControllerRevision extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.ControllerRevision" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ControllerRevisionOptions) { - super(scope, name, { - ...options, - kind: 'ControllerRevision', - apiVersion: 'apps/v1', - }); - } -} - -/** - * ControllerRevisionList is a resource containing a list of ControllerRevision objects. - * - * @schema io.k8s.api.apps.v1.ControllerRevisionList - */ -export class ControllerRevisionList extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.ControllerRevisionList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ControllerRevisionListOptions) { - super(scope, name, { - ...options, - kind: 'ControllerRevisionList', - apiVersion: 'apps/v1', - }); - } -} - -/** - * DaemonSet represents the configuration of a daemon set. - * - * @schema io.k8s.api.apps.v1.DaemonSet - */ -export class DaemonSet extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.DaemonSet" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: DaemonSetOptions = {}) { - super(scope, name, { - ...options, - kind: 'DaemonSet', - apiVersion: 'apps/v1', - }); - } -} - -/** - * DaemonSetList is a collection of daemon sets. - * - * @schema io.k8s.api.apps.v1.DaemonSetList - */ -export class DaemonSetList extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.DaemonSetList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: DaemonSetListOptions) { - super(scope, name, { - ...options, - kind: 'DaemonSetList', - apiVersion: 'apps/v1', - }); - } -} - -/** - * Deployment enables declarative updates for Pods and ReplicaSets. - * - * @schema io.k8s.api.apps.v1.Deployment - */ -export class Deployment extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.Deployment" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: DeploymentOptions = {}) { - super(scope, name, { - ...options, - kind: 'Deployment', - apiVersion: 'apps/v1', - }); - } -} - -/** - * DeploymentList is a list of Deployments. - * - * @schema io.k8s.api.apps.v1.DeploymentList - */ -export class DeploymentList extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.DeploymentList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: DeploymentListOptions) { - super(scope, name, { - ...options, - kind: 'DeploymentList', - apiVersion: 'apps/v1', - }); - } -} - -/** - * ReplicaSet ensures that a specified number of pod replicas are running at any given time. - * - * @schema io.k8s.api.apps.v1.ReplicaSet - */ -export class ReplicaSet extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.ReplicaSet" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ReplicaSetOptions = {}) { - super(scope, name, { - ...options, - kind: 'ReplicaSet', - apiVersion: 'apps/v1', - }); - } -} - -/** - * ReplicaSetList is a collection of ReplicaSets. - * - * @schema io.k8s.api.apps.v1.ReplicaSetList - */ -export class ReplicaSetList extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.ReplicaSetList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ReplicaSetListOptions) { - super(scope, name, { - ...options, - kind: 'ReplicaSetList', - apiVersion: 'apps/v1', - }); - } -} - -/** - * StatefulSet represents a set of pods with consistent identities. Identities are defined as: - - Network: A single stable DNS and hostname. - - Storage: As many VolumeClaims as requested. -The StatefulSet guarantees that a given network identity will always map to the same storage identity. - * - * @schema io.k8s.api.apps.v1.StatefulSet - */ -export class StatefulSet extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.StatefulSet" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: StatefulSetOptions = {}) { - super(scope, name, { - ...options, - kind: 'StatefulSet', - apiVersion: 'apps/v1', - }); - } -} - -/** - * StatefulSetList is a collection of StatefulSets. - * - * @schema io.k8s.api.apps.v1.StatefulSetList - */ -export class StatefulSetList extends ApiObject { - /** - * Defines a "io.k8s.api.apps.v1.StatefulSetList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: StatefulSetListOptions) { - super(scope, name, { - ...options, - kind: 'StatefulSetList', - apiVersion: 'apps/v1', - }); - } -} - -/** - * Scale represents a scaling request for a resource. - * - * @schema io.k8s.api.autoscaling.v1.Scale - */ -export class Scale extends ApiObject { - /** - * Defines a "io.k8s.api.autoscaling.v1.Scale" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ScaleOptions = {}) { - super(scope, name, { - ...options, - kind: 'Scale', - apiVersion: 'autoscaling/v1', - }); - } -} - -/** - * AuditSink represents a cluster level audit sink - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink - */ -export class AuditSink extends ApiObject { - /** - * Defines a "io.k8s.api.auditregistration.v1alpha1.AuditSink" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: AuditSinkOptions = {}) { - super(scope, name, { - ...options, - kind: 'AuditSink', - apiVersion: 'auditregistration.k8s.io/v1alpha1', - }); - } -} - -/** - * AuditSinkList is a list of AuditSink items. - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList - */ -export class AuditSinkList extends ApiObject { - /** - * Defines a "io.k8s.api.auditregistration.v1alpha1.AuditSinkList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: AuditSinkListOptions) { - super(scope, name, { - ...options, - kind: 'AuditSinkList', - apiVersion: 'auditregistration.k8s.io/v1alpha1', - }); - } -} - -/** - * TokenRequest requests a token for a given service account. - * - * @schema io.k8s.api.authentication.v1.TokenRequest - */ -export class TokenRequest extends ApiObject { - /** - * Defines a "io.k8s.api.authentication.v1.TokenRequest" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: TokenRequestOptions) { - super(scope, name, { - ...options, - kind: 'TokenRequest', - apiVersion: 'authentication.k8s.io/v1', - }); - } -} - -/** - * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. - * - * @schema io.k8s.api.authentication.v1.TokenReview - */ -export class TokenReview extends ApiObject { - /** - * Defines a "io.k8s.api.authentication.v1.TokenReview" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: TokenReviewOptions) { - super(scope, name, { - ...options, - kind: 'TokenReview', - apiVersion: 'authentication.k8s.io/v1', - }); - } -} - -/** - * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. - * - * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview - */ -export class LocalSubjectAccessReview extends ApiObject { - /** - * Defines a "io.k8s.api.authorization.v1.LocalSubjectAccessReview" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: LocalSubjectAccessReviewOptions) { - super(scope, name, { - ...options, - kind: 'LocalSubjectAccessReview', - apiVersion: 'authorization.k8s.io/v1', - }); - } -} - -/** - * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action - * - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview - */ -export class SelfSubjectAccessReview extends ApiObject { - /** - * Defines a "io.k8s.api.authorization.v1.SelfSubjectAccessReview" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: SelfSubjectAccessReviewOptions) { - super(scope, name, { - ...options, - kind: 'SelfSubjectAccessReview', - apiVersion: 'authorization.k8s.io/v1', - }); - } -} - -/** - * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. - * - * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview - */ -export class SelfSubjectRulesReview extends ApiObject { - /** - * Defines a "io.k8s.api.authorization.v1.SelfSubjectRulesReview" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: SelfSubjectRulesReviewOptions) { - super(scope, name, { - ...options, - kind: 'SelfSubjectRulesReview', - apiVersion: 'authorization.k8s.io/v1', - }); - } -} - -/** - * SubjectAccessReview checks whether or not a user or group can perform an action. - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReview - */ -export class SubjectAccessReview extends ApiObject { - /** - * Defines a "io.k8s.api.authorization.v1.SubjectAccessReview" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: SubjectAccessReviewOptions) { - super(scope, name, { - ...options, - kind: 'SubjectAccessReview', - apiVersion: 'authorization.k8s.io/v1', - }); - } -} - -/** - * configuration of a horizontal pod autoscaler. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler - */ -export class HorizontalPodAutoscaler extends ApiObject { - /** - * Defines a "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: HorizontalPodAutoscalerOptions = {}) { - super(scope, name, { - ...options, - kind: 'HorizontalPodAutoscaler', - apiVersion: 'autoscaling/v1', - }); - } -} - -/** - * list of horizontal pod autoscaler objects. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList - */ -export class HorizontalPodAutoscalerList extends ApiObject { - /** - * Defines a "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: HorizontalPodAutoscalerListOptions) { - super(scope, name, { - ...options, - kind: 'HorizontalPodAutoscalerList', - apiVersion: 'autoscaling/v1', - }); - } -} - -/** - * Job represents the configuration of a single job. - * - * @schema io.k8s.api.batch.v1.Job - */ -export class Job extends ApiObject { - /** - * Defines a "io.k8s.api.batch.v1.Job" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: JobOptions = {}) { - super(scope, name, { - ...options, - kind: 'Job', - apiVersion: 'batch/v1', - }); - } -} - -/** - * JobList is a collection of jobs. - * - * @schema io.k8s.api.batch.v1.JobList - */ -export class JobList extends ApiObject { - /** - * Defines a "io.k8s.api.batch.v1.JobList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: JobListOptions) { - super(scope, name, { - ...options, - kind: 'JobList', - apiVersion: 'batch/v1', - }); - } -} - -/** - * CronJob represents the configuration of a single cron job. - * - * @schema io.k8s.api.batch.v1beta1.CronJob - */ -export class CronJob extends ApiObject { - /** - * Defines a "io.k8s.api.batch.v1beta1.CronJob" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CronJobOptions = {}) { - super(scope, name, { - ...options, - kind: 'CronJob', - apiVersion: 'batch/v1beta1', - }); - } -} - -/** - * CronJobList is a collection of cron jobs. - * - * @schema io.k8s.api.batch.v1beta1.CronJobList - */ -export class CronJobList extends ApiObject { - /** - * Defines a "io.k8s.api.batch.v1beta1.CronJobList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CronJobListOptions) { - super(scope, name, { - ...options, - kind: 'CronJobList', - apiVersion: 'batch/v1beta1', - }); - } -} - -/** - * Describes a certificate signing request - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest - */ -export class CertificateSigningRequest extends ApiObject { - /** - * Defines a "io.k8s.api.certificates.v1beta1.CertificateSigningRequest" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CertificateSigningRequestOptions = {}) { - super(scope, name, { - ...options, - kind: 'CertificateSigningRequest', - apiVersion: 'certificates.k8s.io/v1beta1', - }); - } -} - -/** - * - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList - */ -export class CertificateSigningRequestList extends ApiObject { - /** - * Defines a "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CertificateSigningRequestListOptions) { - super(scope, name, { - ...options, - kind: 'CertificateSigningRequestList', - apiVersion: 'certificates.k8s.io/v1beta1', - }); - } -} - -/** - * Lease defines a lease concept. - * - * @schema io.k8s.api.coordination.v1.Lease - */ -export class Lease extends ApiObject { - /** - * Defines a "io.k8s.api.coordination.v1.Lease" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: LeaseOptions = {}) { - super(scope, name, { - ...options, - kind: 'Lease', - apiVersion: 'coordination.k8s.io/v1', - }); - } -} - -/** - * LeaseList is a list of Lease objects. - * - * @schema io.k8s.api.coordination.v1.LeaseList - */ -export class LeaseList extends ApiObject { - /** - * Defines a "io.k8s.api.coordination.v1.LeaseList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: LeaseListOptions) { - super(scope, name, { - ...options, - kind: 'LeaseList', - apiVersion: 'coordination.k8s.io/v1', - }); - } -} - -/** - * Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. - * - * @schema io.k8s.api.core.v1.Binding - */ -export class Binding extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Binding" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: BindingOptions) { - super(scope, name, { - ...options, - kind: 'Binding', - apiVersion: 'v1', - }); - } -} - -/** - * ComponentStatus (and ComponentStatusList) holds the cluster validation info. - * - * @schema io.k8s.api.core.v1.ComponentStatus - */ -export class ComponentStatus extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ComponentStatus" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ComponentStatusOptions = {}) { - super(scope, name, { - ...options, - kind: 'ComponentStatus', - apiVersion: 'v1', - }); - } -} - -/** - * Status of all the conditions for the component as a list of ComponentStatus objects. - * - * @schema io.k8s.api.core.v1.ComponentStatusList - */ -export class ComponentStatusList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ComponentStatusList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ComponentStatusListOptions) { - super(scope, name, { - ...options, - kind: 'ComponentStatusList', - apiVersion: 'v1', - }); - } -} - -/** - * ConfigMap holds configuration data for pods to consume. - * - * @schema io.k8s.api.core.v1.ConfigMap - */ -export class ConfigMap extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ConfigMap" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ConfigMapOptions = {}) { - super(scope, name, { - ...options, - kind: 'ConfigMap', - apiVersion: 'v1', - }); - } -} - -/** - * ConfigMapList is a resource containing a list of ConfigMap objects. - * - * @schema io.k8s.api.core.v1.ConfigMapList - */ -export class ConfigMapList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ConfigMapList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ConfigMapListOptions) { - super(scope, name, { - ...options, - kind: 'ConfigMapList', - apiVersion: 'v1', - }); - } -} - -/** - * Endpoints is a collection of endpoints that implement the actual service. Example: - Name: "mysvc", - Subsets: [ - { - Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], - Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] - }, - { - Addresses: [{"ip": "10.10.3.3"}], - Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] - }, - ] - * - * @schema io.k8s.api.core.v1.Endpoints - */ -export class Endpoints extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Endpoints" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EndpointsOptions = {}) { - super(scope, name, { - ...options, - kind: 'Endpoints', - apiVersion: 'v1', - }); - } -} - -/** - * EndpointsList is a list of endpoints. - * - * @schema io.k8s.api.core.v1.EndpointsList - */ -export class EndpointsList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.EndpointsList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EndpointsListOptions) { - super(scope, name, { - ...options, - kind: 'EndpointsList', - apiVersion: 'v1', - }); - } -} - -/** - * Event is a report of an event somewhere in the cluster. - * - * @schema io.k8s.api.core.v1.Event - */ -export class Event extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Event" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EventOptions) { - super(scope, name, { - ...options, - kind: 'Event', - apiVersion: 'v1', - }); - } -} - -/** - * EventList is a list of events. - * - * @schema io.k8s.api.core.v1.EventList - */ -export class EventList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.EventList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EventListOptions) { - super(scope, name, { - ...options, - kind: 'EventList', - apiVersion: 'v1', - }); - } -} - -/** - * LimitRange sets resource usage limits for each kind of resource in a Namespace. - * - * @schema io.k8s.api.core.v1.LimitRange - */ -export class LimitRange extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.LimitRange" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: LimitRangeOptions = {}) { - super(scope, name, { - ...options, - kind: 'LimitRange', - apiVersion: 'v1', - }); - } -} - -/** - * LimitRangeList is a list of LimitRange items. - * - * @schema io.k8s.api.core.v1.LimitRangeList - */ -export class LimitRangeList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.LimitRangeList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: LimitRangeListOptions) { - super(scope, name, { - ...options, - kind: 'LimitRangeList', - apiVersion: 'v1', - }); - } -} - -/** - * Namespace provides a scope for Names. Use of multiple namespaces is optional. - * - * @schema io.k8s.api.core.v1.Namespace - */ -export class Namespace extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Namespace" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: NamespaceOptions = {}) { - super(scope, name, { - ...options, - kind: 'Namespace', - apiVersion: 'v1', - }); - } -} - -/** - * NamespaceList is a list of Namespaces. - * - * @schema io.k8s.api.core.v1.NamespaceList - */ -export class NamespaceList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.NamespaceList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: NamespaceListOptions) { - super(scope, name, { - ...options, - kind: 'NamespaceList', - apiVersion: 'v1', - }); - } -} - -/** - * Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). - * - * @schema io.k8s.api.core.v1.Node - */ -export class Node extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Node" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: NodeOptions = {}) { - super(scope, name, { - ...options, - kind: 'Node', - apiVersion: 'v1', - }); - } -} - -/** - * NodeList is the whole list of all Nodes which have been registered with master. - * - * @schema io.k8s.api.core.v1.NodeList - */ -export class NodeList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.NodeList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: NodeListOptions) { - super(scope, name, { - ...options, - kind: 'NodeList', - apiVersion: 'v1', - }); - } -} - -/** - * PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes - * - * @schema io.k8s.api.core.v1.PersistentVolume - */ -export class PersistentVolume extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PersistentVolume" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PersistentVolumeOptions = {}) { - super(scope, name, { - ...options, - kind: 'PersistentVolume', - apiVersion: 'v1', - }); - } -} - -/** - * PersistentVolumeClaim is a user's request for and claim to a persistent volume - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaim - */ -export class PersistentVolumeClaim extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PersistentVolumeClaim" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PersistentVolumeClaimOptions = {}) { - super(scope, name, { - ...options, - kind: 'PersistentVolumeClaim', - apiVersion: 'v1', - }); - } -} - -/** - * PersistentVolumeClaimList is a list of PersistentVolumeClaim items. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimList - */ -export class PersistentVolumeClaimList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PersistentVolumeClaimList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PersistentVolumeClaimListOptions) { - super(scope, name, { - ...options, - kind: 'PersistentVolumeClaimList', - apiVersion: 'v1', - }); - } -} - -/** - * PersistentVolumeList is a list of PersistentVolume items. - * - * @schema io.k8s.api.core.v1.PersistentVolumeList - */ -export class PersistentVolumeList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PersistentVolumeList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PersistentVolumeListOptions) { - super(scope, name, { - ...options, - kind: 'PersistentVolumeList', - apiVersion: 'v1', - }); - } -} - -/** - * Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. - * - * @schema io.k8s.api.core.v1.Pod - */ -export class Pod extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Pod" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodOptions = {}) { - super(scope, name, { - ...options, - kind: 'Pod', - apiVersion: 'v1', - }); - } -} - -/** - * PodList is a list of Pods. - * - * @schema io.k8s.api.core.v1.PodList - */ -export class PodList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PodList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodListOptions) { - super(scope, name, { - ...options, - kind: 'PodList', - apiVersion: 'v1', - }); - } -} - -/** - * PodTemplate describes a template for creating copies of a predefined pod. - * - * @schema io.k8s.api.core.v1.PodTemplate - */ -export class PodTemplate extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PodTemplate" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodTemplateOptions = {}) { - super(scope, name, { - ...options, - kind: 'PodTemplate', - apiVersion: 'v1', - }); - } -} - -/** - * PodTemplateList is a list of PodTemplates. - * - * @schema io.k8s.api.core.v1.PodTemplateList - */ -export class PodTemplateList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.PodTemplateList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodTemplateListOptions) { - super(scope, name, { - ...options, - kind: 'PodTemplateList', - apiVersion: 'v1', - }); - } -} - -/** - * ReplicationController represents the configuration of a replication controller. - * - * @schema io.k8s.api.core.v1.ReplicationController - */ -export class ReplicationController extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ReplicationController" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ReplicationControllerOptions = {}) { - super(scope, name, { - ...options, - kind: 'ReplicationController', - apiVersion: 'v1', - }); - } -} - -/** - * ReplicationControllerList is a collection of replication controllers. - * - * @schema io.k8s.api.core.v1.ReplicationControllerList - */ -export class ReplicationControllerList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ReplicationControllerList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ReplicationControllerListOptions) { - super(scope, name, { - ...options, - kind: 'ReplicationControllerList', - apiVersion: 'v1', - }); - } -} - -/** - * ResourceQuota sets aggregate quota restrictions enforced per namespace - * - * @schema io.k8s.api.core.v1.ResourceQuota - */ -export class ResourceQuota extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ResourceQuota" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ResourceQuotaOptions = {}) { - super(scope, name, { - ...options, - kind: 'ResourceQuota', - apiVersion: 'v1', - }); - } -} - -/** - * ResourceQuotaList is a list of ResourceQuota items. - * - * @schema io.k8s.api.core.v1.ResourceQuotaList - */ -export class ResourceQuotaList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ResourceQuotaList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ResourceQuotaListOptions) { - super(scope, name, { - ...options, - kind: 'ResourceQuotaList', - apiVersion: 'v1', - }); - } -} - -/** - * Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. - * - * @schema io.k8s.api.core.v1.Secret - */ -export class Secret extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Secret" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: SecretOptions = {}) { - super(scope, name, { - ...options, - kind: 'Secret', - apiVersion: 'v1', - }); - } -} - -/** - * SecretList is a list of Secret. - * - * @schema io.k8s.api.core.v1.SecretList - */ -export class SecretList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.SecretList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: SecretListOptions) { - super(scope, name, { - ...options, - kind: 'SecretList', - apiVersion: 'v1', - }); - } -} - -/** - * Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. - * - * @schema io.k8s.api.core.v1.Service - */ -export class Service extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.Service" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ServiceOptions = {}) { - super(scope, name, { - ...options, - kind: 'Service', - apiVersion: 'v1', - }); - } -} - -/** - * ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets - * - * @schema io.k8s.api.core.v1.ServiceAccount - */ -export class ServiceAccount extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ServiceAccount" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ServiceAccountOptions = {}) { - super(scope, name, { - ...options, - kind: 'ServiceAccount', - apiVersion: 'v1', - }); - } -} - -/** - * ServiceAccountList is a list of ServiceAccount objects - * - * @schema io.k8s.api.core.v1.ServiceAccountList - */ -export class ServiceAccountList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ServiceAccountList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ServiceAccountListOptions) { - super(scope, name, { - ...options, - kind: 'ServiceAccountList', - apiVersion: 'v1', - }); - } -} - -/** - * ServiceList holds a list of services. - * - * @schema io.k8s.api.core.v1.ServiceList - */ -export class ServiceList extends ApiObject { - /** - * Defines a "io.k8s.api.core.v1.ServiceList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ServiceListOptions) { - super(scope, name, { - ...options, - kind: 'ServiceList', - apiVersion: 'v1', - }); - } -} - -/** - * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSlice - */ -export class EndpointSlice extends ApiObject { - /** - * Defines a "io.k8s.api.discovery.v1beta1.EndpointSlice" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EndpointSliceOptions) { - super(scope, name, { - ...options, - kind: 'EndpointSlice', - apiVersion: 'discovery.k8s.io/v1beta1', - }); - } -} - -/** - * EndpointSliceList represents a list of endpoint slices - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList - */ -export class EndpointSliceList extends ApiObject { - /** - * Defines a "io.k8s.api.discovery.v1beta1.EndpointSliceList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EndpointSliceListOptions) { - super(scope, name, { - ...options, - kind: 'EndpointSliceList', - apiVersion: 'discovery.k8s.io/v1beta1', - }); - } -} - -/** - * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. - * - * @schema io.k8s.api.networking.v1beta1.Ingress - */ -export class Ingress extends ApiObject { - /** - * Defines a "io.k8s.api.networking.v1beta1.Ingress" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: IngressOptions = {}) { - super(scope, name, { - ...options, - kind: 'Ingress', - apiVersion: 'networking.k8s.io/v1beta1', - }); - } -} - -/** - * IngressList is a collection of Ingress. - * - * @schema io.k8s.api.networking.v1beta1.IngressList - */ -export class IngressList extends ApiObject { - /** - * Defines a "io.k8s.api.networking.v1beta1.IngressList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: IngressListOptions) { - super(scope, name, { - ...options, - kind: 'IngressList', - apiVersion: 'networking.k8s.io/v1beta1', - }); - } -} - -/** - * NetworkPolicy describes what network traffic is allowed for a set of Pods - * - * @schema io.k8s.api.networking.v1.NetworkPolicy - */ -export class NetworkPolicy extends ApiObject { - /** - * Defines a "io.k8s.api.networking.v1.NetworkPolicy" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: NetworkPolicyOptions = {}) { - super(scope, name, { - ...options, - kind: 'NetworkPolicy', - apiVersion: 'networking.k8s.io/v1', - }); - } -} - -/** - * NetworkPolicyList is a list of NetworkPolicy objects. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyList - */ -export class NetworkPolicyList extends ApiObject { - /** - * Defines a "io.k8s.api.networking.v1.NetworkPolicyList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: NetworkPolicyListOptions) { - super(scope, name, { - ...options, - kind: 'NetworkPolicyList', - apiVersion: 'networking.k8s.io/v1', - }); - } -} - -/** - * PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy - */ -export class PodSecurityPolicy extends ApiObject { - /** - * Defines a "io.k8s.api.policy.v1beta1.PodSecurityPolicy" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodSecurityPolicyOptions = {}) { - super(scope, name, { - ...options, - kind: 'PodSecurityPolicy', - apiVersion: 'policy/v1beta1', - }); - } -} - -/** - * PodSecurityPolicyList is a list of PodSecurityPolicy objects. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList - */ -export class PodSecurityPolicyList extends ApiObject { - /** - * Defines a "io.k8s.api.policy.v1beta1.PodSecurityPolicyList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodSecurityPolicyListOptions) { - super(scope, name, { - ...options, - kind: 'PodSecurityPolicyList', - apiVersion: 'policy/v1beta1', - }); - } -} - -/** - * FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema - */ -export class FlowSchema extends ApiObject { - /** - * Defines a "io.k8s.api.flowcontrol.v1alpha1.FlowSchema" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: FlowSchemaOptions = {}) { - super(scope, name, { - ...options, - kind: 'FlowSchema', - apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', - }); - } -} - -/** - * FlowSchemaList is a list of FlowSchema objects. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList - */ -export class FlowSchemaList extends ApiObject { - /** - * Defines a "io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: FlowSchemaListOptions) { - super(scope, name, { - ...options, - kind: 'FlowSchemaList', - apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', - }); - } -} - -/** - * PriorityLevelConfiguration represents the configuration of a priority level. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration - */ -export class PriorityLevelConfiguration extends ApiObject { - /** - * Defines a "io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PriorityLevelConfigurationOptions = {}) { - super(scope, name, { - ...options, - kind: 'PriorityLevelConfiguration', - apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', - }); - } -} - -/** - * PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList - */ -export class PriorityLevelConfigurationList extends ApiObject { - /** - * Defines a "io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PriorityLevelConfigurationListOptions) { - super(scope, name, { - ...options, - kind: 'PriorityLevelConfigurationList', - apiVersion: 'flowcontrol.apiserver.k8s.io/v1alpha1', - }); - } -} - -/** - * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md - * - * @schema io.k8s.api.node.v1beta1.RuntimeClass - */ -export class RuntimeClass extends ApiObject { - /** - * Defines a "io.k8s.api.node.v1beta1.RuntimeClass" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: RuntimeClassOptions) { - super(scope, name, { - ...options, - kind: 'RuntimeClass', - apiVersion: 'node.k8s.io/v1beta1', - }); - } -} - -/** - * RuntimeClassList is a list of RuntimeClass objects. - * - * @schema io.k8s.api.node.v1beta1.RuntimeClassList - */ -export class RuntimeClassList extends ApiObject { - /** - * Defines a "io.k8s.api.node.v1beta1.RuntimeClassList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: RuntimeClassListOptions) { - super(scope, name, { - ...options, - kind: 'RuntimeClassList', - apiVersion: 'node.k8s.io/v1beta1', - }); - } -} - -/** - * Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. - * - * @schema io.k8s.api.policy.v1beta1.Eviction - */ -export class Eviction extends ApiObject { - /** - * Defines a "io.k8s.api.policy.v1beta1.Eviction" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: EvictionOptions = {}) { - super(scope, name, { - ...options, - kind: 'Eviction', - apiVersion: 'policy/v1beta1', - }); - } -} - -/** - * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget - */ -export class PodDisruptionBudget extends ApiObject { - /** - * Defines a "io.k8s.api.policy.v1beta1.PodDisruptionBudget" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodDisruptionBudgetOptions = {}) { - super(scope, name, { - ...options, - kind: 'PodDisruptionBudget', - apiVersion: 'policy/v1beta1', - }); - } -} - -/** - * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList - */ -export class PodDisruptionBudgetList extends ApiObject { - /** - * Defines a "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodDisruptionBudgetListOptions) { - super(scope, name, { - ...options, - kind: 'PodDisruptionBudgetList', - apiVersion: 'policy/v1beta1', - }); - } -} - -/** - * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - * - * @schema io.k8s.api.rbac.v1.ClusterRole - */ -export class ClusterRole extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.ClusterRole" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ClusterRoleOptions = {}) { - super(scope, name, { - ...options, - kind: 'ClusterRole', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBinding - */ -export class ClusterRoleBinding extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.ClusterRoleBinding" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ClusterRoleBindingOptions) { - super(scope, name, { - ...options, - kind: 'ClusterRoleBinding', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * ClusterRoleBindingList is a collection of ClusterRoleBindings - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList - */ -export class ClusterRoleBindingList extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.ClusterRoleBindingList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ClusterRoleBindingListOptions) { - super(scope, name, { - ...options, - kind: 'ClusterRoleBindingList', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * ClusterRoleList is a collection of ClusterRoles - * - * @schema io.k8s.api.rbac.v1.ClusterRoleList - */ -export class ClusterRoleList extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.ClusterRoleList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ClusterRoleListOptions) { - super(scope, name, { - ...options, - kind: 'ClusterRoleList', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. - * - * @schema io.k8s.api.rbac.v1.Role - */ -export class Role extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.Role" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: RoleOptions = {}) { - super(scope, name, { - ...options, - kind: 'Role', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. - * - * @schema io.k8s.api.rbac.v1.RoleBinding - */ -export class RoleBinding extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.RoleBinding" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: RoleBindingOptions) { - super(scope, name, { - ...options, - kind: 'RoleBinding', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * RoleBindingList is a collection of RoleBindings - * - * @schema io.k8s.api.rbac.v1.RoleBindingList - */ -export class RoleBindingList extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.RoleBindingList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: RoleBindingListOptions) { - super(scope, name, { - ...options, - kind: 'RoleBindingList', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * RoleList is a collection of Roles - * - * @schema io.k8s.api.rbac.v1.RoleList - */ -export class RoleList extends ApiObject { - /** - * Defines a "io.k8s.api.rbac.v1.RoleList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: RoleListOptions) { - super(scope, name, { - ...options, - kind: 'RoleList', - apiVersion: 'rbac.authorization.k8s.io/v1', - }); - } -} - -/** - * PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. - * - * @schema io.k8s.api.scheduling.v1.PriorityClass - */ -export class PriorityClass extends ApiObject { - /** - * Defines a "io.k8s.api.scheduling.v1.PriorityClass" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PriorityClassOptions) { - super(scope, name, { - ...options, - kind: 'PriorityClass', - apiVersion: 'scheduling.k8s.io/v1', - }); - } -} - -/** - * PriorityClassList is a collection of priority classes. - * - * @schema io.k8s.api.scheduling.v1.PriorityClassList - */ -export class PriorityClassList extends ApiObject { - /** - * Defines a "io.k8s.api.scheduling.v1.PriorityClassList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PriorityClassListOptions) { - super(scope, name, { - ...options, - kind: 'PriorityClassList', - apiVersion: 'scheduling.k8s.io/v1', - }); - } -} - -/** - * PodPreset is a policy resource that defines additional runtime requirements for a Pod. - * - * @schema io.k8s.api.settings.v1alpha1.PodPreset - */ -export class PodPreset extends ApiObject { - /** - * Defines a "io.k8s.api.settings.v1alpha1.PodPreset" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodPresetOptions = {}) { - super(scope, name, { - ...options, - kind: 'PodPreset', - apiVersion: 'settings.k8s.io/v1alpha1', - }); - } -} - -/** - * PodPresetList is a list of PodPreset objects. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetList - */ -export class PodPresetList extends ApiObject { - /** - * Defines a "io.k8s.api.settings.v1alpha1.PodPresetList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: PodPresetListOptions) { - super(scope, name, { - ...options, - kind: 'PodPresetList', - apiVersion: 'settings.k8s.io/v1alpha1', - }); - } -} - -/** - * CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. - * - * @schema io.k8s.api.storage.v1.CSINode - */ -export class CsiNode extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1.CSINode" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CsiNodeOptions) { - super(scope, name, { - ...options, - kind: 'CSINode', - apiVersion: 'storage.k8s.io/v1', - }); - } -} - -/** - * CSINodeList is a collection of CSINode objects. - * - * @schema io.k8s.api.storage.v1.CSINodeList - */ -export class CsiNodeList extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1.CSINodeList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CsiNodeListOptions) { - super(scope, name, { - ...options, - kind: 'CSINodeList', - apiVersion: 'storage.k8s.io/v1', - }); - } -} - -/** - * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. - -StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. - * - * @schema io.k8s.api.storage.v1.StorageClass - */ -export class StorageClass extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1.StorageClass" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: StorageClassOptions) { - super(scope, name, { - ...options, - kind: 'StorageClass', - apiVersion: 'storage.k8s.io/v1', - }); - } -} - -/** - * StorageClassList is a collection of storage classes. - * - * @schema io.k8s.api.storage.v1.StorageClassList - */ -export class StorageClassList extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1.StorageClassList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: StorageClassListOptions) { - super(scope, name, { - ...options, - kind: 'StorageClassList', - apiVersion: 'storage.k8s.io/v1', - }); - } -} - -/** - * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. - -VolumeAttachment objects are non-namespaced. - * - * @schema io.k8s.api.storage.v1.VolumeAttachment - */ -export class VolumeAttachment extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1.VolumeAttachment" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: VolumeAttachmentOptions) { - super(scope, name, { - ...options, - kind: 'VolumeAttachment', - apiVersion: 'storage.k8s.io/v1', - }); - } -} - -/** - * VolumeAttachmentList is a collection of VolumeAttachment objects. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentList - */ -export class VolumeAttachmentList extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1.VolumeAttachmentList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: VolumeAttachmentListOptions) { - super(scope, name, { - ...options, - kind: 'VolumeAttachmentList', - apiVersion: 'storage.k8s.io/v1', - }); - } -} - -/** - * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriver - */ -export class CsiDriver extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1beta1.CSIDriver" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CsiDriverOptions) { - super(scope, name, { - ...options, - kind: 'CSIDriver', - apiVersion: 'storage.k8s.io/v1beta1', - }); - } -} - -/** - * CSIDriverList is a collection of CSIDriver objects. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverList - */ -export class CsiDriverList extends ApiObject { - /** - * Defines a "io.k8s.api.storage.v1beta1.CSIDriverList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CsiDriverListOptions) { - super(scope, name, { - ...options, - kind: 'CSIDriverList', - apiVersion: 'storage.k8s.io/v1beta1', - }); - } -} - -/** - * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition - */ -export class CustomResourceDefinition extends ApiObject { - /** - * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CustomResourceDefinitionOptions) { - super(scope, name, { - ...options, - kind: 'CustomResourceDefinition', - apiVersion: 'apiextensions.k8s.io/v1', - }); - } -} - -/** - * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList - */ -export class CustomResourceDefinitionList extends ApiObject { - /** - * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: CustomResourceDefinitionListOptions) { - super(scope, name, { - ...options, - kind: 'CustomResourceDefinitionList', - apiVersion: 'apiextensions.k8s.io/v1', - }); - } -} - -/** - * Status is a return value for calls that don't return other objects. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status - */ -export class Status extends ApiObject { - /** - * Defines a "io.k8s.apimachinery.pkg.apis.meta.v1.Status" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: StatusOptions = {}) { - super(scope, name, { - ...options, - kind: 'Status', - apiVersion: 'v1', - }); - } -} - -/** - * APIService represents a server for a particular GroupVersion. Name must be "version.group". - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService - */ -export class ApiService extends ApiObject { - /** - * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ApiServiceOptions = {}) { - super(scope, name, { - ...options, - kind: 'APIService', - apiVersion: 'apiregistration.k8s.io/v1', - }); - } -} - -/** - * APIServiceList is a list of APIService objects. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList - */ -export class ApiServiceList extends ApiObject { - /** - * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList" API object - * @param scope the scope in which to define this object - * @param name a scope-local name for the object - * @param options configuration options - */ - public constructor(scope: Construct, name: string, options: ApiServiceListOptions) { - super(scope, name, { - ...options, - kind: 'APIServiceList', - apiVersion: 'apiregistration.k8s.io/v1', - }); - } -} - -/** - * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration - */ -export interface MutatingWebhookConfigurationOptions { - /** - * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Webhooks is a list of webhooks and the affected resources and operations. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration#webhooks - */ - readonly webhooks?: MutatingWebhook[]; - -} - -/** - * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList - */ -export interface MutatingWebhookConfigurationListOptions { - /** - * List of MutatingWebhookConfiguration. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList#items - */ - readonly items: MutatingWebhookConfiguration[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration - */ -export interface ValidatingWebhookConfigurationOptions { - /** - * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Webhooks is a list of webhooks and the affected resources and operations. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration#webhooks - */ - readonly webhooks?: ValidatingWebhook[]; - -} - -/** - * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList - */ -export interface ValidatingWebhookConfigurationListOptions { - /** - * List of ValidatingWebhookConfiguration. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList#items - */ - readonly items: ValidatingWebhookConfiguration[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. - * - * @schema io.k8s.api.apps.v1.ControllerRevision - */ -export interface ControllerRevisionOptions { - /** - * Data is the serialized representation of the state. - * - * @schema io.k8s.api.apps.v1.ControllerRevision#data - */ - readonly data?: any; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.apps.v1.ControllerRevision#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Revision indicates the revision of the state represented by Data. - * - * @schema io.k8s.api.apps.v1.ControllerRevision#revision - */ - readonly revision: number; - -} - -/** - * ControllerRevisionList is a resource containing a list of ControllerRevision objects. - * - * @schema io.k8s.api.apps.v1.ControllerRevisionList - */ -export interface ControllerRevisionListOptions { - /** - * Items is the list of ControllerRevisions - * - * @schema io.k8s.api.apps.v1.ControllerRevisionList#items - */ - readonly items: ControllerRevision[]; - - /** - * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.apps.v1.ControllerRevisionList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * DaemonSet represents the configuration of a daemon set. - * - * @schema io.k8s.api.apps.v1.DaemonSet - */ -export interface DaemonSetOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.apps.v1.DaemonSet#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.apps.v1.DaemonSet#spec - */ - readonly spec?: DaemonSetSpec; - -} - -/** - * DaemonSetList is a collection of daemon sets. - * - * @schema io.k8s.api.apps.v1.DaemonSetList - */ -export interface DaemonSetListOptions { - /** - * A list of daemon sets. - * - * @schema io.k8s.api.apps.v1.DaemonSetList#items - */ - readonly items: DaemonSet[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.apps.v1.DaemonSetList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Deployment enables declarative updates for Pods and ReplicaSets. - * - * @schema io.k8s.api.apps.v1.Deployment - */ -export interface DeploymentOptions { - /** - * Standard object metadata. - * - * @schema io.k8s.api.apps.v1.Deployment#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior of the Deployment. - * - * @schema io.k8s.api.apps.v1.Deployment#spec - */ - readonly spec?: DeploymentSpec; - -} - -/** - * DeploymentList is a list of Deployments. - * - * @schema io.k8s.api.apps.v1.DeploymentList - */ -export interface DeploymentListOptions { - /** - * Items is the list of Deployments. - * - * @schema io.k8s.api.apps.v1.DeploymentList#items - */ - readonly items: Deployment[]; - - /** - * Standard list metadata. - * - * @schema io.k8s.api.apps.v1.DeploymentList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ReplicaSet ensures that a specified number of pod replicas are running at any given time. - * - * @schema io.k8s.api.apps.v1.ReplicaSet - */ -export interface ReplicaSetOptions { - /** - * If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.apps.v1.ReplicaSet#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.apps.v1.ReplicaSet#spec - */ - readonly spec?: ReplicaSetSpec; - -} - -/** - * ReplicaSetList is a collection of ReplicaSets. - * - * @schema io.k8s.api.apps.v1.ReplicaSetList - */ -export interface ReplicaSetListOptions { - /** - * List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller - * - * @schema io.k8s.api.apps.v1.ReplicaSetList#items - */ - readonly items: ReplicaSet[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.apps.v1.ReplicaSetList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * StatefulSet represents a set of pods with consistent identities. Identities are defined as: - - Network: A single stable DNS and hostname. - - Storage: As many VolumeClaims as requested. -The StatefulSet guarantees that a given network identity will always map to the same storage identity. - * - * @schema io.k8s.api.apps.v1.StatefulSet - */ -export interface StatefulSetOptions { - /** - * @schema io.k8s.api.apps.v1.StatefulSet#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the desired identities of pods in this set. - * - * @schema io.k8s.api.apps.v1.StatefulSet#spec - */ - readonly spec?: StatefulSetSpec; - -} - -/** - * StatefulSetList is a collection of StatefulSets. - * - * @schema io.k8s.api.apps.v1.StatefulSetList - */ -export interface StatefulSetListOptions { - /** - * @schema io.k8s.api.apps.v1.StatefulSetList#items - */ - readonly items: StatefulSet[]; - - /** - * @schema io.k8s.api.apps.v1.StatefulSetList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Scale represents a scaling request for a resource. - * - * @schema io.k8s.api.autoscaling.v1.Scale - */ -export interface ScaleOptions { - /** - * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. - * - * @schema io.k8s.api.autoscaling.v1.Scale#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. - * - * @schema io.k8s.api.autoscaling.v1.Scale#spec - */ - readonly spec?: ScaleSpec; - -} - -/** - * AuditSink represents a cluster level audit sink - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink - */ -export interface AuditSinkOptions { - /** - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the audit configuration spec - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSink#spec - */ - readonly spec?: AuditSinkSpec; - -} - -/** - * AuditSinkList is a list of AuditSink items. - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList - */ -export interface AuditSinkListOptions { - /** - * List of audit configurations. - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList#items - */ - readonly items: AuditSink[]; - - /** - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * TokenRequest requests a token for a given service account. - * - * @schema io.k8s.api.authentication.v1.TokenRequest - */ -export interface TokenRequestOptions { - /** - * @schema io.k8s.api.authentication.v1.TokenRequest#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * @schema io.k8s.api.authentication.v1.TokenRequest#spec - */ - readonly spec: TokenRequestSpec; - -} - -/** - * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. - * - * @schema io.k8s.api.authentication.v1.TokenReview - */ -export interface TokenReviewOptions { - /** - * @schema io.k8s.api.authentication.v1.TokenReview#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec holds information about the request being evaluated - * - * @schema io.k8s.api.authentication.v1.TokenReview#spec - */ - readonly spec: TokenReviewSpec; - -} - -/** - * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. - * - * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview - */ -export interface LocalSubjectAccessReviewOptions { - /** - * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. - * - * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview#spec - */ - readonly spec: SubjectAccessReviewSpec; - -} - -/** - * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action - * - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview - */ -export interface SelfSubjectAccessReviewOptions { - /** - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec holds information about the request being evaluated. user and groups must be empty - * - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview#spec - */ - readonly spec: SelfSubjectAccessReviewSpec; - -} - -/** - * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. - * - * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview - */ -export interface SelfSubjectRulesReviewOptions { - /** - * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec holds information about the request being evaluated. - * - * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview#spec - */ - readonly spec: SelfSubjectRulesReviewSpec; - -} - -/** - * SubjectAccessReview checks whether or not a user or group can perform an action. - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReview - */ -export interface SubjectAccessReviewOptions { - /** - * @schema io.k8s.api.authorization.v1.SubjectAccessReview#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec holds information about the request being evaluated - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReview#spec - */ - readonly spec: SubjectAccessReviewSpec; - -} - -/** - * configuration of a horizontal pod autoscaler. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler - */ -export interface HorizontalPodAutoscalerOptions { - /** - * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler#spec - */ - readonly spec?: HorizontalPodAutoscalerSpec; - -} - -/** - * list of horizontal pod autoscaler objects. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList - */ -export interface HorizontalPodAutoscalerListOptions { - /** - * list of horizontal pod autoscaler objects. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList#items - */ - readonly items: HorizontalPodAutoscaler[]; - - /** - * Standard list metadata. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Job represents the configuration of a single job. - * - * @schema io.k8s.api.batch.v1.Job - */ -export interface JobOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.batch.v1.Job#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * 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 - * - * @schema io.k8s.api.batch.v1.Job#spec - */ - readonly spec?: JobSpec; - -} - -/** - * JobList is a collection of jobs. - * - * @schema io.k8s.api.batch.v1.JobList - */ -export interface JobListOptions { - /** - * items is the list of Jobs. - * - * @schema io.k8s.api.batch.v1.JobList#items - */ - readonly items: Job[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.batch.v1.JobList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * CronJob represents the configuration of a single cron job. - * - * @schema io.k8s.api.batch.v1beta1.CronJob - */ -export interface CronJobOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.batch.v1beta1.CronJob#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.batch.v1beta1.CronJob#spec - */ - readonly spec?: CronJobSpec; - -} - -/** - * CronJobList is a collection of cron jobs. - * - * @schema io.k8s.api.batch.v1beta1.CronJobList - */ -export interface CronJobListOptions { - /** - * items is the list of CronJobs. - * - * @schema io.k8s.api.batch.v1beta1.CronJobList#items - */ - readonly items: CronJob[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.batch.v1beta1.CronJobList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Describes a certificate signing request - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest - */ -export interface CertificateSigningRequestOptions { - /** - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * The certificate request itself and any additional information. - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest#spec - */ - readonly spec?: CertificateSigningRequestSpec; - -} - -/** - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList - */ -export interface CertificateSigningRequestListOptions { - /** - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList#items - */ - readonly items: CertificateSigningRequest[]; - - /** - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Lease defines a lease concept. - * - * @schema io.k8s.api.coordination.v1.Lease - */ -export interface LeaseOptions { - /** - * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.coordination.v1.Lease#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.coordination.v1.Lease#spec - */ - readonly spec?: LeaseSpec; - -} - -/** - * LeaseList is a list of Lease objects. - * - * @schema io.k8s.api.coordination.v1.LeaseList - */ -export interface LeaseListOptions { - /** - * Items is a list of schema objects. - * - * @schema io.k8s.api.coordination.v1.LeaseList#items - */ - readonly items: Lease[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.coordination.v1.LeaseList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. - * - * @schema io.k8s.api.core.v1.Binding - */ -export interface BindingOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Binding#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * The target object that you want to bind to the standard object. - * - * @schema io.k8s.api.core.v1.Binding#target - */ - readonly target: ObjectReference; - -} - -/** - * ComponentStatus (and ComponentStatusList) holds the cluster validation info. - * - * @schema io.k8s.api.core.v1.ComponentStatus - */ -export interface ComponentStatusOptions { - /** - * List of component conditions observed - * - * @schema io.k8s.api.core.v1.ComponentStatus#conditions - */ - readonly conditions?: ComponentCondition[]; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.ComponentStatus#metadata - */ - readonly metadata?: ObjectMeta; - -} - -/** - * Status of all the conditions for the component as a list of ComponentStatus objects. - * - * @schema io.k8s.api.core.v1.ComponentStatusList - */ -export interface ComponentStatusListOptions { - /** - * List of ComponentStatus objects. - * - * @schema io.k8s.api.core.v1.ComponentStatusList#items - */ - readonly items: ComponentStatus[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.ComponentStatusList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ConfigMap holds configuration data for pods to consume. - * - * @schema io.k8s.api.core.v1.ConfigMap - */ -export interface ConfigMapOptions { - /** - * BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. - * - * @schema io.k8s.api.core.v1.ConfigMap#binaryData - */ - readonly binaryData?: { [key: string]: string }; - - /** - * Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. - * - * @schema io.k8s.api.core.v1.ConfigMap#data - */ - readonly data?: { [key: string]: string }; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.ConfigMap#metadata - */ - readonly metadata?: ObjectMeta; - -} - -/** - * ConfigMapList is a resource containing a list of ConfigMap objects. - * - * @schema io.k8s.api.core.v1.ConfigMapList - */ -export interface ConfigMapListOptions { - /** - * Items is the list of ConfigMaps. - * - * @schema io.k8s.api.core.v1.ConfigMapList#items - */ - readonly items: ConfigMap[]; - - /** - * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.ConfigMapList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Endpoints is a collection of endpoints that implement the actual service. Example: - Name: "mysvc", - Subsets: [ - { - Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], - Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] - }, - { - Addresses: [{"ip": "10.10.3.3"}], - Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] - }, - ] - * - * @schema io.k8s.api.core.v1.Endpoints - */ -export interface EndpointsOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Endpoints#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. - * - * @schema io.k8s.api.core.v1.Endpoints#subsets - */ - readonly subsets?: EndpointSubset[]; - -} - -/** - * EndpointsList is a list of endpoints. - * - * @schema io.k8s.api.core.v1.EndpointsList - */ -export interface EndpointsListOptions { - /** - * List of endpoints. - * - * @schema io.k8s.api.core.v1.EndpointsList#items - */ - readonly items: Endpoints[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.EndpointsList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Event is a report of an event somewhere in the cluster. - * - * @schema io.k8s.api.core.v1.Event - */ -export interface EventOptions { - /** - * What action was taken/failed regarding to the Regarding object. - * - * @schema io.k8s.api.core.v1.Event#action - */ - readonly action?: string; - - /** - * The number of times this event has occurred. - * - * @schema io.k8s.api.core.v1.Event#count - */ - readonly count?: number; - - /** - * Time when this Event was first observed. - * - * @schema io.k8s.api.core.v1.Event#eventTime - */ - readonly eventTime?: Date; - - /** - * The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) - * - * @schema io.k8s.api.core.v1.Event#firstTimestamp - */ - readonly firstTimestamp?: Date; - - /** - * The object that this event is about. - * - * @schema io.k8s.api.core.v1.Event#involvedObject - */ - readonly involvedObject: ObjectReference; - - /** - * The time at which the most recent occurrence of this event was recorded. - * - * @schema io.k8s.api.core.v1.Event#lastTimestamp - */ - readonly lastTimestamp?: Date; - - /** - * A human-readable description of the status of this operation. - * - * @schema io.k8s.api.core.v1.Event#message - */ - readonly message?: string; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Event#metadata - */ - readonly metadata: ObjectMeta; - - /** - * This should be a short, machine understandable string that gives the reason for the transition into the object's current status. - * - * @schema io.k8s.api.core.v1.Event#reason - */ - readonly reason?: string; - - /** - * Optional secondary object for more complex actions. - * - * @schema io.k8s.api.core.v1.Event#related - */ - readonly related?: ObjectReference; - - /** - * Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. - * - * @schema io.k8s.api.core.v1.Event#reportingComponent - */ - readonly reportingComponent?: string; - - /** - * ID of the controller instance, e.g. `kubelet-xyzf`. - * - * @schema io.k8s.api.core.v1.Event#reportingInstance - */ - readonly reportingInstance?: string; - - /** - * Data about the Event series this event represents or nil if it's a singleton Event. - * - * @schema io.k8s.api.core.v1.Event#series - */ - readonly series?: EventSeries; - - /** - * The component reporting this event. Should be a short machine understandable string. - * - * @schema io.k8s.api.core.v1.Event#source - */ - readonly source?: EventSource; - - /** - * Type of this event (Normal, Warning), new types could be added in the future - * - * @schema io.k8s.api.core.v1.Event#type - */ - readonly type?: string; - -} - -/** - * EventList is a list of events. - * - * @schema io.k8s.api.core.v1.EventList - */ -export interface EventListOptions { - /** - * List of events - * - * @schema io.k8s.api.core.v1.EventList#items - */ - readonly items: Event[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.EventList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * LimitRange sets resource usage limits for each kind of resource in a Namespace. - * - * @schema io.k8s.api.core.v1.LimitRange - */ -export interface LimitRangeOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.LimitRange#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.LimitRange#spec - */ - readonly spec?: LimitRangeSpec; - -} - -/** - * LimitRangeList is a list of LimitRange items. - * - * @schema io.k8s.api.core.v1.LimitRangeList - */ -export interface LimitRangeListOptions { - /** - * Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - * - * @schema io.k8s.api.core.v1.LimitRangeList#items - */ - readonly items: LimitRange[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.LimitRangeList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Namespace provides a scope for Names. Use of multiple namespaces is optional. - * - * @schema io.k8s.api.core.v1.Namespace - */ -export interface NamespaceOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Namespace#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.Namespace#spec - */ - readonly spec?: NamespaceSpec; - -} - -/** - * NamespaceList is a list of Namespaces. - * - * @schema io.k8s.api.core.v1.NamespaceList - */ -export interface NamespaceListOptions { - /** - * Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - * - * @schema io.k8s.api.core.v1.NamespaceList#items - */ - readonly items: Namespace[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.NamespaceList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). - * - * @schema io.k8s.api.core.v1.Node - */ -export interface NodeOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Node#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.Node#spec - */ - readonly spec?: NodeSpec; - -} - -/** - * NodeList is the whole list of all Nodes which have been registered with master. - * - * @schema io.k8s.api.core.v1.NodeList - */ -export interface NodeListOptions { - /** - * List of nodes - * - * @schema io.k8s.api.core.v1.NodeList#items - */ - readonly items: Node[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.NodeList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes - * - * @schema io.k8s.api.core.v1.PersistentVolume - */ -export interface PersistentVolumeOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.PersistentVolume#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes - * - * @schema io.k8s.api.core.v1.PersistentVolume#spec - */ - readonly spec?: PersistentVolumeSpec; - -} - -/** - * PersistentVolumeClaim is a user's request for and claim to a persistent volume - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaim - */ -export interface PersistentVolumeClaimOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaim#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaim#spec - */ - readonly spec?: PersistentVolumeClaimSpec; - -} - -/** - * PersistentVolumeClaimList is a list of PersistentVolumeClaim items. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimList - */ -export interface PersistentVolumeClaimListOptions { - /** - * A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimList#items - */ - readonly items: PersistentVolumeClaim[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PersistentVolumeList is a list of PersistentVolume items. - * - * @schema io.k8s.api.core.v1.PersistentVolumeList - */ -export interface PersistentVolumeListOptions { - /** - * List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes - * - * @schema io.k8s.api.core.v1.PersistentVolumeList#items - */ - readonly items: PersistentVolume[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.PersistentVolumeList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. - * - * @schema io.k8s.api.core.v1.Pod - */ -export interface PodOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Pod#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.Pod#spec - */ - readonly spec?: PodSpec; - -} - -/** - * PodList is a list of Pods. - * - * @schema io.k8s.api.core.v1.PodList - */ -export interface PodListOptions { - /** - * List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - * - * @schema io.k8s.api.core.v1.PodList#items - */ - readonly items: Pod[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.PodList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PodTemplate describes a template for creating copies of a predefined pod. - * - * @schema io.k8s.api.core.v1.PodTemplate - */ -export interface PodTemplateOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.PodTemplate#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.PodTemplate#template - */ - readonly template?: PodTemplateSpec; - -} - -/** - * PodTemplateList is a list of PodTemplates. - * - * @schema io.k8s.api.core.v1.PodTemplateList - */ -export interface PodTemplateListOptions { - /** - * List of pod templates - * - * @schema io.k8s.api.core.v1.PodTemplateList#items - */ - readonly items: PodTemplate[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.PodTemplateList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ReplicationController represents the configuration of a replication controller. - * - * @schema io.k8s.api.core.v1.ReplicationController - */ -export interface ReplicationControllerOptions { - /** - * If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.ReplicationController#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.ReplicationController#spec - */ - readonly spec?: ReplicationControllerSpec; - -} - -/** - * ReplicationControllerList is a collection of replication controllers. - * - * @schema io.k8s.api.core.v1.ReplicationControllerList - */ -export interface ReplicationControllerListOptions { - /** - * List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller - * - * @schema io.k8s.api.core.v1.ReplicationControllerList#items - */ - readonly items: ReplicationController[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.ReplicationControllerList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ResourceQuota sets aggregate quota restrictions enforced per namespace - * - * @schema io.k8s.api.core.v1.ResourceQuota - */ -export interface ResourceQuotaOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.ResourceQuota#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.ResourceQuota#spec - */ - readonly spec?: ResourceQuotaSpec; - -} - -/** - * ResourceQuotaList is a list of ResourceQuota items. - * - * @schema io.k8s.api.core.v1.ResourceQuotaList - */ -export interface ResourceQuotaListOptions { - /** - * Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ - * - * @schema io.k8s.api.core.v1.ResourceQuotaList#items - */ - readonly items: ResourceQuota[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.ResourceQuotaList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. - * - * @schema io.k8s.api.core.v1.Secret - */ -export interface SecretOptions { - /** - * Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 - * - * @schema io.k8s.api.core.v1.Secret#data - */ - readonly data?: { [key: string]: string }; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Secret#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. - * - * @schema io.k8s.api.core.v1.Secret#stringData - */ - readonly stringData?: { [key: string]: string }; - - /** - * Used to facilitate programmatic handling of secret data. - * - * @schema io.k8s.api.core.v1.Secret#type - */ - readonly type?: string; - -} - -/** - * SecretList is a list of Secret. - * - * @schema io.k8s.api.core.v1.SecretList - */ -export interface SecretListOptions { - /** - * Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret - * - * @schema io.k8s.api.core.v1.SecretList#items - */ - readonly items: Secret[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.SecretList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. - * - * @schema io.k8s.api.core.v1.Service - */ -export interface ServiceOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.Service#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.Service#spec - */ - readonly spec?: ServiceSpec; - -} - -/** - * ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets - * - * @schema io.k8s.api.core.v1.ServiceAccount - */ -export interface ServiceAccountOptions { - /** - * AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. - * - * @schema io.k8s.api.core.v1.ServiceAccount#automountServiceAccountToken - */ - readonly automountServiceAccountToken?: boolean; - - /** - * ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod - * - * @schema io.k8s.api.core.v1.ServiceAccount#imagePullSecrets - */ - readonly imagePullSecrets?: LocalObjectReference[]; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.ServiceAccount#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret - * - * @schema io.k8s.api.core.v1.ServiceAccount#secrets - */ - readonly secrets?: ObjectReference[]; - -} - -/** - * ServiceAccountList is a list of ServiceAccount objects - * - * @schema io.k8s.api.core.v1.ServiceAccountList - */ -export interface ServiceAccountListOptions { - /** - * List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ - * - * @schema io.k8s.api.core.v1.ServiceAccountList#items - */ - readonly items: ServiceAccount[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.ServiceAccountList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ServiceList holds a list of services. - * - * @schema io.k8s.api.core.v1.ServiceList - */ -export interface ServiceListOptions { - /** - * List of services - * - * @schema io.k8s.api.core.v1.ServiceList#items - */ - readonly items: Service[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.ServiceList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSlice - */ -export interface EndpointSliceOptions { - /** - * addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#addressType - */ - readonly addressType: string; - - /** - * endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#endpoints - */ - readonly endpoints: Endpoint[]; - - /** - * Standard object's metadata. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#ports - */ - readonly ports?: EndpointPort[]; - -} - -/** - * EndpointSliceList represents a list of endpoint slices - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList - */ -export interface EndpointSliceListOptions { - /** - * List of endpoint slices - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList#items - */ - readonly items: EndpointSlice[]; - - /** - * Standard list metadata. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. - * - * @schema io.k8s.api.networking.v1beta1.Ingress - */ -export interface IngressOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.networking.v1beta1.Ingress#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.networking.v1beta1.Ingress#spec - */ - readonly spec?: IngressSpec; - -} - -/** - * IngressList is a collection of Ingress. - * - * @schema io.k8s.api.networking.v1beta1.IngressList - */ -export interface IngressListOptions { - /** - * Items is the list of Ingress. - * - * @schema io.k8s.api.networking.v1beta1.IngressList#items - */ - readonly items: Ingress[]; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.networking.v1beta1.IngressList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * NetworkPolicy describes what network traffic is allowed for a set of Pods - * - * @schema io.k8s.api.networking.v1.NetworkPolicy - */ -export interface NetworkPolicyOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.networking.v1.NetworkPolicy#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior for this NetworkPolicy. - * - * @schema io.k8s.api.networking.v1.NetworkPolicy#spec - */ - readonly spec?: NetworkPolicySpec; - -} - -/** - * NetworkPolicyList is a list of NetworkPolicy objects. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyList - */ -export interface NetworkPolicyListOptions { - /** - * Items is a list of schema objects. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyList#items - */ - readonly items: NetworkPolicy[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.networking.v1.NetworkPolicyList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy - */ -export interface PodSecurityPolicyOptions { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * spec defines the policy enforced. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy#spec - */ - readonly spec?: PodSecurityPolicySpec; - -} - -/** - * PodSecurityPolicyList is a list of PodSecurityPolicy objects. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList - */ -export interface PodSecurityPolicyListOptions { - /** - * items is a list of schema objects. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList#items - */ - readonly items: PodSecurityPolicy[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema - */ -export interface FlowSchemaOptions { - /** - * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchema#spec - */ - readonly spec?: FlowSchemaSpec; - -} - -/** - * FlowSchemaList is a list of FlowSchema objects. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList - */ -export interface FlowSchemaListOptions { - /** - * `items` is a list of FlowSchemas. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList#items - */ - readonly items: FlowSchema[]; - - /** - * `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PriorityLevelConfiguration represents the configuration of a priority level. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration - */ -export interface PriorityLevelConfigurationOptions { - /** - * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfiguration#spec - */ - readonly spec?: PriorityLevelConfigurationSpec; - -} - -/** - * PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList - */ -export interface PriorityLevelConfigurationListOptions { - /** - * `items` is a list of request-priorities. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList#items - */ - readonly items: PriorityLevelConfiguration[]; - - /** - * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md - * - * @schema io.k8s.api.node.v1beta1.RuntimeClass - */ -export interface RuntimeClassOptions { - /** - * Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must conform to the DNS Label (RFC 1123) requirements, and is immutable. - * - * @schema io.k8s.api.node.v1beta1.RuntimeClass#handler - */ - readonly handler: string; - - /** - * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.node.v1beta1.RuntimeClass#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. - * - * @schema io.k8s.api.node.v1beta1.RuntimeClass#overhead - */ - readonly overhead?: Overhead; - - /** - * Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. - * - * @schema io.k8s.api.node.v1beta1.RuntimeClass#scheduling - */ - readonly scheduling?: Scheduling; - -} - -/** - * RuntimeClassList is a list of RuntimeClass objects. - * - * @schema io.k8s.api.node.v1beta1.RuntimeClassList - */ -export interface RuntimeClassListOptions { - /** - * Items is a list of schema objects. - * - * @schema io.k8s.api.node.v1beta1.RuntimeClassList#items - */ - readonly items: RuntimeClass[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.node.v1beta1.RuntimeClassList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. - * - * @schema io.k8s.api.policy.v1beta1.Eviction - */ -export interface EvictionOptions { - /** - * DeleteOptions may be provided - * - * @schema io.k8s.api.policy.v1beta1.Eviction#deleteOptions - */ - readonly deleteOptions?: DeleteOptions; - - /** - * ObjectMeta describes the pod that is being evicted. - * - * @schema io.k8s.api.policy.v1beta1.Eviction#metadata - */ - readonly metadata?: ObjectMeta; - -} - -/** - * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget - */ -export interface PodDisruptionBudgetOptions { - /** - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior of the PodDisruptionBudget. - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget#spec - */ - readonly spec?: PodDisruptionBudgetSpec; - -} - -/** - * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList - */ -export interface PodDisruptionBudgetListOptions { - /** - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList#items - */ - readonly items: PodDisruptionBudget[]; - - /** - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - * - * @schema io.k8s.api.rbac.v1.ClusterRole - */ -export interface ClusterRoleOptions { - /** - * AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. - * - * @schema io.k8s.api.rbac.v1.ClusterRole#aggregationRule - */ - readonly aggregationRule?: AggregationRule; - - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.ClusterRole#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Rules holds all the PolicyRules for this ClusterRole - * - * @schema io.k8s.api.rbac.v1.ClusterRole#rules - */ - readonly rules?: PolicyRule[]; - -} - -/** - * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBinding - */ -export interface ClusterRoleBindingOptions { - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#roleRef - */ - readonly roleRef: RoleRef; - - /** - * Subjects holds references to the objects the role applies to. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#subjects - */ - readonly subjects?: Subject[]; - -} - -/** - * ClusterRoleBindingList is a collection of ClusterRoleBindings - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList - */ -export interface ClusterRoleBindingListOptions { - /** - * Items is a list of ClusterRoleBindings - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList#items - */ - readonly items: ClusterRoleBinding[]; - - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ClusterRoleList is a collection of ClusterRoles - * - * @schema io.k8s.api.rbac.v1.ClusterRoleList - */ -export interface ClusterRoleListOptions { - /** - * Items is a list of ClusterRoles - * - * @schema io.k8s.api.rbac.v1.ClusterRoleList#items - */ - readonly items: ClusterRole[]; - - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.ClusterRoleList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. - * - * @schema io.k8s.api.rbac.v1.Role - */ -export interface RoleOptions { - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.Role#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Rules holds all the PolicyRules for this Role - * - * @schema io.k8s.api.rbac.v1.Role#rules - */ - readonly rules?: PolicyRule[]; - -} - -/** - * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. - * - * @schema io.k8s.api.rbac.v1.RoleBinding - */ -export interface RoleBindingOptions { - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.RoleBinding#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. - * - * @schema io.k8s.api.rbac.v1.RoleBinding#roleRef - */ - readonly roleRef: RoleRef; - - /** - * Subjects holds references to the objects the role applies to. - * - * @schema io.k8s.api.rbac.v1.RoleBinding#subjects - */ - readonly subjects?: Subject[]; - -} - -/** - * RoleBindingList is a collection of RoleBindings - * - * @schema io.k8s.api.rbac.v1.RoleBindingList - */ -export interface RoleBindingListOptions { - /** - * Items is a list of RoleBindings - * - * @schema io.k8s.api.rbac.v1.RoleBindingList#items - */ - readonly items: RoleBinding[]; - - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.RoleBindingList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * RoleList is a collection of Roles - * - * @schema io.k8s.api.rbac.v1.RoleList - */ -export interface RoleListOptions { - /** - * Items is a list of Roles - * - * @schema io.k8s.api.rbac.v1.RoleList#items - */ - readonly items: Role[]; - - /** - * Standard object's metadata. - * - * @schema io.k8s.api.rbac.v1.RoleList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. - * - * @schema io.k8s.api.scheduling.v1.PriorityClass - */ -export interface PriorityClassOptions { - /** - * description is an arbitrary string that usually provides guidelines on when this priority class should be used. - * - * @schema io.k8s.api.scheduling.v1.PriorityClass#description - */ - readonly description?: string; - - /** - * globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. - * - * @schema io.k8s.api.scheduling.v1.PriorityClass#globalDefault - */ - readonly globalDefault?: boolean; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.scheduling.v1.PriorityClass#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. - * - * @default PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. - * @schema io.k8s.api.scheduling.v1.PriorityClass#preemptionPolicy - */ - readonly preemptionPolicy?: string; - - /** - * The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. - * - * @schema io.k8s.api.scheduling.v1.PriorityClass#value - */ - readonly value: number; - -} - -/** - * PriorityClassList is a collection of priority classes. - * - * @schema io.k8s.api.scheduling.v1.PriorityClassList - */ -export interface PriorityClassListOptions { - /** - * items is the list of PriorityClasses - * - * @schema io.k8s.api.scheduling.v1.PriorityClassList#items - */ - readonly items: PriorityClass[]; - - /** - * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.scheduling.v1.PriorityClassList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * PodPreset is a policy resource that defines additional runtime requirements for a Pod. - * - * @schema io.k8s.api.settings.v1alpha1.PodPreset - */ -export interface PodPresetOptions { - /** - * @schema io.k8s.api.settings.v1alpha1.PodPreset#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * @schema io.k8s.api.settings.v1alpha1.PodPreset#spec - */ - readonly spec?: PodPresetSpec; - -} - -/** - * PodPresetList is a list of PodPreset objects. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetList - */ -export interface PodPresetListOptions { - /** - * Items is a list of schema objects. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetList#items - */ - readonly items: PodPreset[]; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. - * - * @schema io.k8s.api.storage.v1.CSINode - */ -export interface CsiNodeOptions { - /** - * metadata.name must be the Kubernetes node name. - * - * @schema io.k8s.api.storage.v1.CSINode#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * spec is the specification of CSINode - * - * @schema io.k8s.api.storage.v1.CSINode#spec - */ - readonly spec: CsiNodeSpec; - -} - -/** - * CSINodeList is a collection of CSINode objects. - * - * @schema io.k8s.api.storage.v1.CSINodeList - */ -export interface CsiNodeListOptions { - /** - * items is the list of CSINode - * - * @schema io.k8s.api.storage.v1.CSINodeList#items - */ - readonly items: CsiNode[]; - - /** - * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1.CSINodeList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. - -StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. - * - * @schema io.k8s.api.storage.v1.StorageClass - */ -export interface StorageClassOptions { - /** - * AllowVolumeExpansion shows whether the storage class allow volume expand - * - * @schema io.k8s.api.storage.v1.StorageClass#allowVolumeExpansion - */ - readonly allowVolumeExpansion?: boolean; - - /** - * Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. - * - * @schema io.k8s.api.storage.v1.StorageClass#allowedTopologies - */ - readonly allowedTopologies?: TopologySelectorTerm[]; - - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1.StorageClass#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. - * - * @schema io.k8s.api.storage.v1.StorageClass#mountOptions - */ - readonly mountOptions?: string[]; - - /** - * Parameters holds the parameters for the provisioner that should create volumes of this storage class. - * - * @schema io.k8s.api.storage.v1.StorageClass#parameters - */ - readonly parameters?: { [key: string]: string }; - - /** - * Provisioner indicates the type of the provisioner. - * - * @schema io.k8s.api.storage.v1.StorageClass#provisioner - */ - readonly provisioner: string; - - /** - * Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. - * - * @default Delete. - * @schema io.k8s.api.storage.v1.StorageClass#reclaimPolicy - */ - readonly reclaimPolicy?: string; - - /** - * VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. - * - * @schema io.k8s.api.storage.v1.StorageClass#volumeBindingMode - */ - readonly volumeBindingMode?: string; - -} - -/** - * StorageClassList is a collection of storage classes. - * - * @schema io.k8s.api.storage.v1.StorageClassList - */ -export interface StorageClassListOptions { - /** - * Items is the list of StorageClasses - * - * @schema io.k8s.api.storage.v1.StorageClassList#items - */ - readonly items: StorageClass[]; - - /** - * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1.StorageClassList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. - -VolumeAttachment objects are non-namespaced. - * - * @schema io.k8s.api.storage.v1.VolumeAttachment - */ -export interface VolumeAttachmentOptions { - /** - * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1.VolumeAttachment#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. - * - * @schema io.k8s.api.storage.v1.VolumeAttachment#spec - */ - readonly spec: VolumeAttachmentSpec; - -} - -/** - * VolumeAttachmentList is a collection of VolumeAttachment objects. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentList - */ -export interface VolumeAttachmentListOptions { - /** - * Items is the list of VolumeAttachments - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentList#items - */ - readonly items: VolumeAttachment[]; - - /** - * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriver - */ -export interface CsiDriverOptions { - /** - * Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1beta1.CSIDriver#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the CSI Driver. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriver#spec - */ - readonly spec: CsiDriverSpec; - -} - -/** - * CSIDriverList is a collection of CSIDriver objects. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverList - */ -export interface CsiDriverListOptions { - /** - * items is the list of CSIDriver - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverList#items - */ - readonly items: CsiDriver[]; - - /** - * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition - */ -export interface CustomResourceDefinitionOptions { - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * spec describes how the user wants the resources to appear - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition#spec - */ - readonly spec: CustomResourceDefinitionSpec; - -} - -/** - * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList - */ -export interface CustomResourceDefinitionListOptions { - /** - * items list individual CustomResourceDefinition objects - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList#items - */ - readonly items: CustomResourceDefinition[]; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * Status is a return value for calls that don't return other objects. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status - */ -export interface StatusOptions { - /** - * Suggested HTTP return code for this status, 0 if not set. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#code - */ - readonly code?: number; - - /** - * Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#details - */ - readonly details?: StatusDetails; - - /** - * A human-readable description of the status of this operation. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#message - */ - readonly message?: string; - - /** - * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#metadata - */ - readonly metadata?: ListMeta; - - /** - * A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#reason - */ - readonly reason?: string; - -} - -/** - * APIService represents a server for a particular GroupVersion. Name must be "version.group". - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService - */ -export interface ApiServiceOptions { - /** - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Spec contains information for locating and communicating with a server - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService#spec - */ - readonly spec?: ApiServiceSpec; - -} - -/** - * APIServiceList is a list of APIService objects. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList - */ -export interface ApiServiceListOptions { - /** - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList#items - */ - readonly items: ApiService[]; - - /** - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList#metadata - */ - readonly metadata?: ListMeta; - -} - -/** - * ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta - */ -export interface ObjectMeta { - /** - * Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#annotations - */ - readonly annotations?: { [key: string]: string }; - - /** - * The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#clusterName - */ - readonly clusterName?: string; - - /** - * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. - -Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#creationTimestamp - */ - readonly creationTimestamp?: Date; - - /** - * Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#deletionGracePeriodSeconds - */ - readonly deletionGracePeriodSeconds?: number; - - /** - * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. - -Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#deletionTimestamp - */ - readonly deletionTimestamp?: Date; - - /** - * Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#finalizers - */ - readonly finalizers?: string[]; - - /** - * GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. - -If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). - -Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#generateName - */ - readonly generateName?: string; - - /** - * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#generation - */ - readonly generation?: number; - - /** - * Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#labels - */ - readonly labels?: { [key: string]: string }; - - /** - * ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#managedFields - */ - readonly managedFields?: ManagedFieldsEntry[]; - - /** - * Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#name - */ - readonly name?: string; - - /** - * Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. - -Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#namespace - */ - readonly namespace?: string; - - /** - * List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#ownerReferences - */ - readonly ownerReferences?: OwnerReference[]; - - /** - * An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. - -Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#resourceVersion - */ - readonly resourceVersion?: string; - - /** - * SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#selfLink - */ - readonly selfLink?: string; - - /** - * UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. - -Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#uid - */ - readonly uid?: string; - -} - -/** - * MutatingWebhook describes an admission webhook and the resources and operations it applies to. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook - */ -export interface MutatingWebhook { - /** - * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#admissionReviewVersions - */ - readonly admissionReviewVersions: string[]; - - /** - * ClientConfig defines how to communicate with the hook. Required - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#clientConfig - */ - readonly clientConfig: WebhookClientConfig; - - /** - * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. - * - * @default Fail. - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#failurePolicy - */ - readonly failurePolicy?: string; - - /** - * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - -- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - -- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. - -Defaults to "Equivalent" - * - * @default Equivalent" - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#matchPolicy - */ - readonly matchPolicy?: string; - - /** - * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#name - */ - readonly name: string; - - /** - * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. - -For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { - "matchExpressions": [ - { - "key": "runlevel", - "operator": "NotIn", - "values": [ - "0", - "1" - ] - } - ] -} - -If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { - "matchExpressions": [ - { - "key": "environment", - "operator": "In", - "values": [ - "prod", - "staging" - ] - } - ] -} - -See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. - -Default to the empty LabelSelector, which matches everything. - * - * @default the empty LabelSelector, which matches everything. - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#namespaceSelector - */ - readonly namespaceSelector?: LabelSelector; - - /** - * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. - * - * @default the empty LabelSelector, which matches everything. - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#objectSelector - */ - readonly objectSelector?: LabelSelector; - - /** - * reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". - -Never: the webhook will not be called more than once in a single admission evaluation. - -IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. - -Defaults to "Never". - * - * @default Never". - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#reinvocationPolicy - */ - readonly reinvocationPolicy?: string; - - /** - * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#rules - */ - readonly rules?: RuleWithOperations[]; - - /** - * SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. - * - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#sideEffects - */ - readonly sideEffects: string; - - /** - * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. - * - * @default 10 seconds. - * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#timeoutSeconds - */ - readonly timeoutSeconds?: number; - -} - -/** - * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta - */ -export interface ListMeta { - /** - * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#continue - */ - readonly continue?: string; - - /** - * remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#remainingItemCount - */ - readonly remainingItemCount?: number; - - /** - * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to 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 - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#resourceVersion - */ - readonly resourceVersion?: string; - - /** - * selfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#selfLink - */ - readonly selfLink?: string; - -} - -/** - * ValidatingWebhook describes an admission webhook and the resources and operations it applies to. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook - */ -export interface ValidatingWebhook { - /** - * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#admissionReviewVersions - */ - readonly admissionReviewVersions: string[]; - - /** - * ClientConfig defines how to communicate with the hook. Required - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#clientConfig - */ - readonly clientConfig: WebhookClientConfig; - - /** - * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. - * - * @default Fail. - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#failurePolicy - */ - readonly failurePolicy?: string; - - /** - * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - -- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - -- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. - -Defaults to "Equivalent" - * - * @default Equivalent" - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#matchPolicy - */ - readonly matchPolicy?: string; - - /** - * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#name - */ - readonly name: string; - - /** - * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. - -For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { - "matchExpressions": [ - { - "key": "runlevel", - "operator": "NotIn", - "values": [ - "0", - "1" - ] - } - ] -} - -If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { - "matchExpressions": [ - { - "key": "environment", - "operator": "In", - "values": [ - "prod", - "staging" - ] - } - ] -} - -See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. - -Default to the empty LabelSelector, which matches everything. - * - * @default the empty LabelSelector, which matches everything. - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#namespaceSelector - */ - readonly namespaceSelector?: LabelSelector; - - /** - * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. - * - * @default the empty LabelSelector, which matches everything. - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#objectSelector - */ - readonly objectSelector?: LabelSelector; - - /** - * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#rules - */ - readonly rules?: RuleWithOperations[]; - - /** - * SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. - * - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#sideEffects - */ - readonly sideEffects: string; - - /** - * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. - * - * @default 10 seconds. - * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#timeoutSeconds - */ - readonly timeoutSeconds?: number; - -} - -/** - * DaemonSetSpec is the specification of a daemon set. - * - * @schema io.k8s.api.apps.v1.DaemonSetSpec - */ -export interface DaemonSetSpec { - /** - * The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). - * - * @default 0 (pod will be considered available as soon as it is ready). - * @schema io.k8s.api.apps.v1.DaemonSetSpec#minReadySeconds - */ - readonly minReadySeconds?: number; - - /** - * The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. - * - * @default 10. - * @schema io.k8s.api.apps.v1.DaemonSetSpec#revisionHistoryLimit - */ - readonly revisionHistoryLimit?: number; - - /** - * A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - * - * @schema io.k8s.api.apps.v1.DaemonSetSpec#selector - */ - readonly selector: LabelSelector; - - /** - * An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template - * - * @schema io.k8s.api.apps.v1.DaemonSetSpec#template - */ - readonly template: PodTemplateSpec; - - /** - * An update strategy to replace existing DaemonSet pods with new pods. - * - * @schema io.k8s.api.apps.v1.DaemonSetSpec#updateStrategy - */ - readonly updateStrategy?: DaemonSetUpdateStrategy; - -} - -/** - * DeploymentSpec is the specification of the desired behavior of the Deployment. - * - * @schema io.k8s.api.apps.v1.DeploymentSpec - */ -export interface DeploymentSpec { - /** - * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) - * - * @default 0 (pod will be considered available as soon as it is ready) - * @schema io.k8s.api.apps.v1.DeploymentSpec#minReadySeconds - */ - readonly minReadySeconds?: number; - - /** - * Indicates that the deployment is paused. - * - * @schema io.k8s.api.apps.v1.DeploymentSpec#paused - */ - readonly paused?: boolean; - - /** - * The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. - * - * @default 600s. - * @schema io.k8s.api.apps.v1.DeploymentSpec#progressDeadlineSeconds - */ - readonly progressDeadlineSeconds?: number; - - /** - * Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. - * - * @default 1. - * @schema io.k8s.api.apps.v1.DeploymentSpec#replicas - */ - readonly replicas?: number; - - /** - * The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. - * - * @default 10. - * @schema io.k8s.api.apps.v1.DeploymentSpec#revisionHistoryLimit - */ - readonly revisionHistoryLimit?: number; - - /** - * Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. - * - * @schema io.k8s.api.apps.v1.DeploymentSpec#selector - */ - readonly selector: LabelSelector; - - /** - * The deployment strategy to use to replace existing pods with new ones. - * - * @schema io.k8s.api.apps.v1.DeploymentSpec#strategy - */ - readonly strategy?: DeploymentStrategy; - - /** - * Template describes the pods that will be created. - * - * @schema io.k8s.api.apps.v1.DeploymentSpec#template - */ - readonly template: PodTemplateSpec; - -} - -/** - * ReplicaSetSpec is the specification of a ReplicaSet. - * - * @schema io.k8s.api.apps.v1.ReplicaSetSpec - */ -export interface ReplicaSetSpec { - /** - * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) - * - * @default 0 (pod will be considered available as soon as it is ready) - * @schema io.k8s.api.apps.v1.ReplicaSetSpec#minReadySeconds - */ - readonly minReadySeconds?: number; - - /** - * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller - * - * @default 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller - * @schema io.k8s.api.apps.v1.ReplicaSetSpec#replicas - */ - readonly replicas?: number; - - /** - * Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - * - * @schema io.k8s.api.apps.v1.ReplicaSetSpec#selector - */ - readonly selector: LabelSelector; - - /** - * Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template - * - * @schema io.k8s.api.apps.v1.ReplicaSetSpec#template - */ - readonly template?: PodTemplateSpec; - -} - -/** - * A StatefulSetSpec is the specification of a StatefulSet. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec - */ -export interface StatefulSetSpec { - /** - * podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#podManagementPolicy - */ - readonly podManagementPolicy?: string; - - /** - * replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#replicas - */ - readonly replicas?: number; - - /** - * revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#revisionHistoryLimit - */ - readonly revisionHistoryLimit?: number; - - /** - * selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#selector - */ - readonly selector: LabelSelector; - - /** - * serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#serviceName - */ - readonly serviceName: string; - - /** - * template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#template - */ - readonly template: PodTemplateSpec; - - /** - * updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#updateStrategy - */ - readonly updateStrategy?: StatefulSetUpdateStrategy; - - /** - * volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. - * - * @schema io.k8s.api.apps.v1.StatefulSetSpec#volumeClaimTemplates - */ - readonly volumeClaimTemplates?: PersistentVolumeClaim[]; - -} - -/** - * ScaleSpec describes the attributes of a scale subresource. - * - * @schema io.k8s.api.autoscaling.v1.ScaleSpec - */ -export interface ScaleSpec { - /** - * desired number of instances for the scaled object. - * - * @schema io.k8s.api.autoscaling.v1.ScaleSpec#replicas - */ - readonly replicas?: number; - -} - -/** - * AuditSinkSpec holds the spec for the audit sink - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkSpec - */ -export interface AuditSinkSpec { - /** - * Policy defines the policy for selecting which events should be sent to the webhook required - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkSpec#policy - */ - readonly policy: Policy; - - /** - * Webhook to send events required - * - * @schema io.k8s.api.auditregistration.v1alpha1.AuditSinkSpec#webhook - */ - readonly webhook: Webhook; - -} - -/** - * TokenRequestSpec contains client provided parameters of a token request. - * - * @schema io.k8s.api.authentication.v1.TokenRequestSpec - */ -export interface TokenRequestSpec { - /** - * Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. - * - * @schema io.k8s.api.authentication.v1.TokenRequestSpec#audiences - */ - readonly audiences: string[]; - - /** - * BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. - * - * @schema io.k8s.api.authentication.v1.TokenRequestSpec#boundObjectRef - */ - readonly boundObjectRef?: BoundObjectReference; - - /** - * ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. - * - * @schema io.k8s.api.authentication.v1.TokenRequestSpec#expirationSeconds - */ - readonly expirationSeconds?: number; - -} - -/** - * TokenReviewSpec is a description of the token authentication request. - * - * @schema io.k8s.api.authentication.v1.TokenReviewSpec - */ -export interface TokenReviewSpec { - /** - * Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. - * - * @schema io.k8s.api.authentication.v1.TokenReviewSpec#audiences - */ - readonly audiences?: string[]; - - /** - * Token is the opaque bearer token. - * - * @schema io.k8s.api.authentication.v1.TokenReviewSpec#token - */ - readonly token?: string; - -} - -/** - * SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec - */ -export interface SubjectAccessReviewSpec { - /** - * Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#extra - */ - readonly extra?: { [key: string]: string[] }; - - /** - * Groups is the groups you're testing for. - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#groups - */ - readonly groups?: string[]; - - /** - * NonResourceAttributes describes information for a non-resource access request - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#nonResourceAttributes - */ - readonly nonResourceAttributes?: NonResourceAttributes; - - /** - * ResourceAuthorizationAttributes describes information for a resource access request - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#resourceAttributes - */ - readonly resourceAttributes?: ResourceAttributes; - - /** - * UID information about the requesting user. - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#uid - */ - readonly uid?: string; - - /** - * User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups - * - * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#user - */ - readonly user?: string; - -} - -/** - * SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set - * - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec - */ -export interface SelfSubjectAccessReviewSpec { - /** - * NonResourceAttributes describes information for a non-resource access request - * - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec#nonResourceAttributes - */ - readonly nonResourceAttributes?: NonResourceAttributes; - - /** - * ResourceAuthorizationAttributes describes information for a resource access request - * - * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec#resourceAttributes - */ - readonly resourceAttributes?: ResourceAttributes; - -} - -/** - * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec - */ -export interface SelfSubjectRulesReviewSpec { - /** - * Namespace to evaluate rules for. Required. - * - * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec#namespace - */ - readonly namespace?: string; - -} - -/** - * specification of a horizontal pod autoscaler. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec - */ -export interface HorizontalPodAutoscalerSpec { - /** - * upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#maxReplicas - */ - readonly maxReplicas: number; - - /** - * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#minReplicas - */ - readonly minReplicas?: number; - - /** - * reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#scaleTargetRef - */ - readonly scaleTargetRef: CrossVersionObjectReference; - - /** - * target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. - * - * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#targetCPUUtilizationPercentage - */ - readonly targetCPUUtilizationPercentage?: number; - -} - -/** - * JobSpec describes how the job execution will look like. - * - * @schema io.k8s.api.batch.v1.JobSpec - */ -export interface JobSpec { - /** - * Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer - * - * @schema io.k8s.api.batch.v1.JobSpec#activeDeadlineSeconds - */ - readonly activeDeadlineSeconds?: number; - - /** - * Specifies the number of retries before marking this job failed. Defaults to 6 - * - * @default 6 - * @schema io.k8s.api.batch.v1.JobSpec#backoffLimit - */ - readonly backoffLimit?: number; - - /** - * Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ - * - * @schema io.k8s.api.batch.v1.JobSpec#completions - */ - readonly completions?: number; - - /** - * manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector - * - * @schema io.k8s.api.batch.v1.JobSpec#manualSelector - */ - readonly manualSelector?: boolean; - - /** - * Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ - * - * @schema io.k8s.api.batch.v1.JobSpec#parallelism - */ - readonly parallelism?: number; - - /** - * A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - * - * @schema io.k8s.api.batch.v1.JobSpec#selector - */ - readonly selector?: LabelSelector; - - /** - * Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ - * - * @schema io.k8s.api.batch.v1.JobSpec#template - */ - readonly template: PodTemplateSpec; - - /** - * ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. - * - * @schema io.k8s.api.batch.v1.JobSpec#ttlSecondsAfterFinished - */ - readonly ttlSecondsAfterFinished?: number; - -} - -/** - * CronJobSpec describes how the job execution will look like and when it will actually run. - * - * @schema io.k8s.api.batch.v1beta1.CronJobSpec - */ -export interface CronJobSpec { - /** - * Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one - * - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#concurrencyPolicy - */ - readonly concurrencyPolicy?: string; - - /** - * The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. - * - * @default 1. - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#failedJobsHistoryLimit - */ - readonly failedJobsHistoryLimit?: number; - - /** - * Specifies the job that will be created when executing a CronJob. - * - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#jobTemplate - */ - readonly jobTemplate: JobTemplateSpec; - - /** - * The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. - * - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#schedule - */ - readonly schedule: string; - - /** - * Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. - * - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#startingDeadlineSeconds - */ - readonly startingDeadlineSeconds?: number; - - /** - * The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. - * - * @default 3. - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#successfulJobsHistoryLimit - */ - readonly successfulJobsHistoryLimit?: number; - - /** - * This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - * - * @default false. - * @schema io.k8s.api.batch.v1beta1.CronJobSpec#suspend - */ - readonly suspend?: boolean; - -} - -/** - * This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec - */ -export interface CertificateSigningRequestSpec { - /** - * Extra information about the requesting user. See user.Info interface for details. - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#extra - */ - readonly extra?: { [key: string]: string[] }; - - /** - * Group information about the requesting user. See user.Info interface for details. - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#groups - */ - readonly groups?: string[]; - - /** - * Base64-encoded PKCS#10 CSR data - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#request - */ - readonly request: string; - - /** - * UID information about the requesting user. See user.Info interface for details. - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#uid - */ - readonly uid?: string; - - /** - * allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 - https://tools.ietf.org/html/rfc5280#section-4.2.1.12 - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#usages - */ - readonly usages?: string[]; - - /** - * Information about the requesting user. See user.Info interface for details. - * - * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#username - */ - readonly username?: string; - -} - -/** - * LeaseSpec is a specification of a Lease. - * - * @schema io.k8s.api.coordination.v1.LeaseSpec - */ -export interface LeaseSpec { - /** - * acquireTime is a time when the current lease was acquired. - * - * @schema io.k8s.api.coordination.v1.LeaseSpec#acquireTime - */ - readonly acquireTime?: Date; - - /** - * holderIdentity contains the identity of the holder of a current lease. - * - * @schema io.k8s.api.coordination.v1.LeaseSpec#holderIdentity - */ - readonly holderIdentity?: string; - - /** - * leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. - * - * @schema io.k8s.api.coordination.v1.LeaseSpec#leaseDurationSeconds - */ - readonly leaseDurationSeconds?: number; - - /** - * leaseTransitions is the number of transitions of a lease between holders. - * - * @schema io.k8s.api.coordination.v1.LeaseSpec#leaseTransitions - */ - readonly leaseTransitions?: number; - - /** - * renewTime is a time when the current holder of a lease has last updated the lease. - * - * @schema io.k8s.api.coordination.v1.LeaseSpec#renewTime - */ - readonly renewTime?: Date; - -} - -/** - * ObjectReference contains enough information to let you inspect or modify the referred object. - * - * @schema io.k8s.api.core.v1.ObjectReference - */ -export interface ObjectReference { - /** - * API version of the referent. - * - * @schema io.k8s.api.core.v1.ObjectReference#apiVersion - */ - readonly apiVersion?: string; - - /** - * If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. - * - * @schema io.k8s.api.core.v1.ObjectReference#fieldPath - */ - readonly fieldPath?: string; - - /** - * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.api.core.v1.ObjectReference#kind - */ - readonly kind?: string; - - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.ObjectReference#name - */ - readonly name?: string; - - /** - * Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - * - * @schema io.k8s.api.core.v1.ObjectReference#namespace - */ - readonly namespace?: string; - - /** - * Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - * - * @schema io.k8s.api.core.v1.ObjectReference#resourceVersion - */ - readonly resourceVersion?: string; - - /** - * UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids - * - * @schema io.k8s.api.core.v1.ObjectReference#uid - */ - readonly uid?: string; - -} - -/** - * Information about the condition of a component. - * - * @schema io.k8s.api.core.v1.ComponentCondition - */ -export interface ComponentCondition { - /** - * Condition error code for a component. For example, a health check error code. - * - * @schema io.k8s.api.core.v1.ComponentCondition#error - */ - readonly error?: string; - - /** - * Message about the condition for a component. For example, information about a health check. - * - * @schema io.k8s.api.core.v1.ComponentCondition#message - */ - readonly message?: string; - - /** - * Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". - * - * @schema io.k8s.api.core.v1.ComponentCondition#status - */ - readonly status: string; - - /** - * Type of condition for a component. Valid value: "Healthy" - * - * @schema io.k8s.api.core.v1.ComponentCondition#type - */ - readonly type: string; - -} - -/** - * EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: - { - Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], - Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] - } -The resulting set of endpoints can be viewed as: - a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], - b: [ 10.10.1.1:309, 10.10.2.2:309 ] - * - * @schema io.k8s.api.core.v1.EndpointSubset - */ -export interface EndpointSubset { - /** - * IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. - * - * @schema io.k8s.api.core.v1.EndpointSubset#addresses - */ - readonly addresses?: EndpointAddress[]; - - /** - * IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. - * - * @schema io.k8s.api.core.v1.EndpointSubset#notReadyAddresses - */ - readonly notReadyAddresses?: EndpointAddress[]; - - /** - * Port numbers available on the related IP addresses. - * - * @schema io.k8s.api.core.v1.EndpointSubset#ports - */ - readonly ports?: EndpointPort[]; - -} - -/** - * EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. - * - * @schema io.k8s.api.core.v1.EventSeries - */ -export interface EventSeries { - /** - * Number of occurrences in this series up to the last heartbeat time - * - * @schema io.k8s.api.core.v1.EventSeries#count - */ - readonly count?: number; - - /** - * Time of the last occurrence observed - * - * @schema io.k8s.api.core.v1.EventSeries#lastObservedTime - */ - readonly lastObservedTime?: Date; - - /** - * State of this Series: Ongoing or Finished Deprecated. Planned removal for 1.18 - * - * @schema io.k8s.api.core.v1.EventSeries#state - */ - readonly state?: string; - -} - -/** - * EventSource contains information for an event. - * - * @schema io.k8s.api.core.v1.EventSource - */ -export interface EventSource { - /** - * Component from which the event is generated. - * - * @schema io.k8s.api.core.v1.EventSource#component - */ - readonly component?: string; - - /** - * Node name on which the event is generated. - * - * @schema io.k8s.api.core.v1.EventSource#host - */ - readonly host?: string; - -} - -/** - * LimitRangeSpec defines a min/max usage limit for resources that match on kind. - * - * @schema io.k8s.api.core.v1.LimitRangeSpec - */ -export interface LimitRangeSpec { - /** - * Limits is the list of LimitRangeItem objects that are enforced. - * - * @schema io.k8s.api.core.v1.LimitRangeSpec#limits - */ - readonly limits: LimitRangeItem[]; - -} - -/** - * NamespaceSpec describes the attributes on a Namespace. - * - * @schema io.k8s.api.core.v1.NamespaceSpec - */ -export interface NamespaceSpec { - /** - * Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ - * - * @schema io.k8s.api.core.v1.NamespaceSpec#finalizers - */ - readonly finalizers?: string[]; - -} - -/** - * NodeSpec describes the attributes that a node is created with. - * - * @schema io.k8s.api.core.v1.NodeSpec - */ -export interface NodeSpec { - /** - * If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field - * - * @schema io.k8s.api.core.v1.NodeSpec#configSource - */ - readonly configSource?: NodeConfigSource; - - /** - * Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 - * - * @schema io.k8s.api.core.v1.NodeSpec#externalID - */ - readonly externalID?: string; - - /** - * PodCIDR represents the pod IP range assigned to the node. - * - * @schema io.k8s.api.core.v1.NodeSpec#podCIDR - */ - readonly podCIDR?: string; - - /** - * podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. - * - * @schema io.k8s.api.core.v1.NodeSpec#podCIDRs - */ - readonly podCIDRs?: string[]; - - /** - * ID of the node assigned by the cloud provider in the format: :// - * - * @schema io.k8s.api.core.v1.NodeSpec#providerID - */ - readonly providerID?: string; - - /** - * If specified, the node's taints. - * - * @schema io.k8s.api.core.v1.NodeSpec#taints - */ - readonly taints?: Taint[]; - - /** - * Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration - * - * @schema io.k8s.api.core.v1.NodeSpec#unschedulable - */ - readonly unschedulable?: boolean; - -} - -/** - * PersistentVolumeSpec is the specification of a persistent volume. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec - */ -export interface PersistentVolumeSpec { - /** - * AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#accessModes - */ - readonly accessModes?: string[]; - - /** - * AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#awsElasticBlockStore - */ - readonly awsElasticBlockStore?: AwsElasticBlockStoreVolumeSource; - - /** - * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#azureDisk - */ - readonly azureDisk?: AzureDiskVolumeSource; - - /** - * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#azureFile - */ - readonly azureFile?: AzureFilePersistentVolumeSource; - - /** - * A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#capacity - */ - readonly capacity?: { [key: string]: Quantity }; - - /** - * CephFS represents a Ceph FS mount on the host that shares a pod's lifetime - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#cephfs - */ - readonly cephfs?: CephFsPersistentVolumeSource; - - /** - * Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#cinder - */ - readonly cinder?: CinderPersistentVolumeSource; - - /** - * ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#claimRef - */ - readonly claimRef?: ObjectReference; - - /** - * CSI represents storage that is handled by an external CSI driver (Beta feature). - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#csi - */ - readonly csi?: CsiPersistentVolumeSource; - - /** - * FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#fc - */ - readonly fc?: FcVolumeSource; - - /** - * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#flexVolume - */ - readonly flexVolume?: FlexPersistentVolumeSource; - - /** - * Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#flocker - */ - readonly flocker?: FlockerVolumeSource; - - /** - * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#gcePersistentDisk - */ - readonly gcePersistentDisk?: GcePersistentDiskVolumeSource; - - /** - * Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#glusterfs - */ - readonly glusterfs?: GlusterfsPersistentVolumeSource; - - /** - * HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#hostPath - */ - readonly hostPath?: HostPathVolumeSource; - - /** - * ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#iscsi - */ - readonly iscsi?: IscsiPersistentVolumeSource; - - /** - * Local represents directly-attached storage with node affinity - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#local - */ - readonly local?: LocalVolumeSource; - - /** - * A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#mountOptions - */ - readonly mountOptions?: string[]; - - /** - * NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#nfs - */ - readonly nfs?: NfsVolumeSource; - - /** - * NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#nodeAffinity - */ - readonly nodeAffinity?: VolumeNodeAffinity; - - /** - * What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#persistentVolumeReclaimPolicy - */ - readonly persistentVolumeReclaimPolicy?: string; - - /** - * PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#photonPersistentDisk - */ - readonly photonPersistentDisk?: PhotonPersistentDiskVolumeSource; - - /** - * PortworxVolume represents a portworx volume attached and mounted on kubelets host machine - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#portworxVolume - */ - readonly portworxVolume?: PortworxVolumeSource; - - /** - * Quobyte represents a Quobyte mount on the host that shares a pod's lifetime - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#quobyte - */ - readonly quobyte?: QuobyteVolumeSource; - - /** - * RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#rbd - */ - readonly rbd?: RbdPersistentVolumeSource; - - /** - * ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#scaleIO - */ - readonly scaleIO?: ScaleIoPersistentVolumeSource; - - /** - * Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#storageClassName - */ - readonly storageClassName?: string; - - /** - * StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#storageos - */ - readonly storageos?: StorageOsPersistentVolumeSource; - - /** - * volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is a beta feature. - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#volumeMode - */ - readonly volumeMode?: string; - - /** - * VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - * - * @schema io.k8s.api.core.v1.PersistentVolumeSpec#vsphereVolume - */ - readonly vsphereVolume?: VsphereVirtualDiskVolumeSource; - -} - -/** - * PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec - */ -export interface PersistentVolumeClaimSpec { - /** - * AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#accessModes - */ - readonly accessModes?: string[]; - - /** - * This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#dataSource - */ - readonly dataSource?: TypedLocalObjectReference; - - /** - * Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#resources - */ - readonly resources?: ResourceRequirements; - - /** - * A label query over volumes to consider for binding. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#selector - */ - readonly selector?: LabelSelector; - - /** - * Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#storageClassName - */ - readonly storageClassName?: string; - - /** - * volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#volumeMode - */ - readonly volumeMode?: string; - - /** - * VolumeName is the binding reference to the PersistentVolume backing this claim. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#volumeName - */ - readonly volumeName?: string; - -} - -/** - * PodSpec is a description of a pod. - * - * @schema io.k8s.api.core.v1.PodSpec - */ -export interface PodSpec { - /** - * Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. - * - * @schema io.k8s.api.core.v1.PodSpec#activeDeadlineSeconds - */ - readonly activeDeadlineSeconds?: number; - - /** - * If specified, the pod's scheduling constraints - * - * @schema io.k8s.api.core.v1.PodSpec#affinity - */ - readonly affinity?: Affinity; - - /** - * AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. - * - * @schema io.k8s.api.core.v1.PodSpec#automountServiceAccountToken - */ - readonly automountServiceAccountToken?: boolean; - - /** - * List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. - * - * @schema io.k8s.api.core.v1.PodSpec#containers - */ - readonly containers: Container[]; - - /** - * Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. - * - * @schema io.k8s.api.core.v1.PodSpec#dnsConfig - */ - readonly dnsConfig?: PodDnsConfig; - - /** - * Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. - * - * @default ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. - * @schema io.k8s.api.core.v1.PodSpec#dnsPolicy - */ - readonly dnsPolicy?: string; - - /** - * EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. - * - * @default true. - * @schema io.k8s.api.core.v1.PodSpec#enableServiceLinks - */ - readonly enableServiceLinks?: boolean; - - /** - * List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. - * - * @schema io.k8s.api.core.v1.PodSpec#ephemeralContainers - */ - readonly ephemeralContainers?: EphemeralContainer[]; - - /** - * HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. - * - * @schema io.k8s.api.core.v1.PodSpec#hostAliases - */ - readonly hostAliases?: HostAlias[]; - - /** - * Use the host's ipc namespace. Optional: Default to false. - * - * @default false. - * @schema io.k8s.api.core.v1.PodSpec#hostIPC - */ - readonly hostIPC?: boolean; - - /** - * Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. - * - * @default false. - * @schema io.k8s.api.core.v1.PodSpec#hostNetwork - */ - readonly hostNetwork?: boolean; - - /** - * Use the host's pid namespace. Optional: Default to false. - * - * @default false. - * @schema io.k8s.api.core.v1.PodSpec#hostPID - */ - readonly hostPID?: boolean; - - /** - * Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. - * - * @schema io.k8s.api.core.v1.PodSpec#hostname - */ - readonly hostname?: string; - - /** - * ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod - * - * @schema io.k8s.api.core.v1.PodSpec#imagePullSecrets - */ - readonly imagePullSecrets?: LocalObjectReference[]; - - /** - * List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ - * - * @schema io.k8s.api.core.v1.PodSpec#initContainers - */ - readonly initContainers?: Container[]; - - /** - * NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. - * - * @schema io.k8s.api.core.v1.PodSpec#nodeName - */ - readonly nodeName?: string; - - /** - * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ - * - * @schema io.k8s.api.core.v1.PodSpec#nodeSelector - */ - readonly nodeSelector?: { [key: string]: string }; - - /** - * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. - * - * @schema io.k8s.api.core.v1.PodSpec#overhead - */ - readonly overhead?: { [key: string]: Quantity }; - - /** - * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. - * - * @default PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. - * @schema io.k8s.api.core.v1.PodSpec#preemptionPolicy - */ - readonly preemptionPolicy?: string; - - /** - * The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. - * - * @schema io.k8s.api.core.v1.PodSpec#priority - */ - readonly priority?: number; - - /** - * If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. - * - * @schema io.k8s.api.core.v1.PodSpec#priorityClassName - */ - readonly priorityClassName?: string; - - /** - * If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md - * - * @schema io.k8s.api.core.v1.PodSpec#readinessGates - */ - readonly readinessGates?: PodReadinessGate[]; - - /** - * Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy - * - * @default Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy - * @schema io.k8s.api.core.v1.PodSpec#restartPolicy - */ - readonly restartPolicy?: string; - - /** - * RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. - * - * @schema io.k8s.api.core.v1.PodSpec#runtimeClassName - */ - readonly runtimeClassName?: string; - - /** - * If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. - * - * @schema io.k8s.api.core.v1.PodSpec#schedulerName - */ - readonly schedulerName?: string; - - /** - * SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. - * - * @default empty. See type description for default values of each field. - * @schema io.k8s.api.core.v1.PodSpec#securityContext - */ - readonly securityContext?: PodSecurityContext; - - /** - * DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. - * - * @schema io.k8s.api.core.v1.PodSpec#serviceAccount - */ - readonly serviceAccount?: string; - - /** - * ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ - * - * @schema io.k8s.api.core.v1.PodSpec#serviceAccountName - */ - readonly serviceAccountName?: string; - - /** - * Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. - * - * @default false. - * @schema io.k8s.api.core.v1.PodSpec#shareProcessNamespace - */ - readonly shareProcessNamespace?: boolean; - - /** - * If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. - * - * @schema io.k8s.api.core.v1.PodSpec#subdomain - */ - readonly subdomain?: string; - - /** - * Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. - * - * @default 30 seconds. - * @schema io.k8s.api.core.v1.PodSpec#terminationGracePeriodSeconds - */ - readonly terminationGracePeriodSeconds?: number; - - /** - * If specified, the pod's tolerations. - * - * @schema io.k8s.api.core.v1.PodSpec#tolerations - */ - readonly tolerations?: Toleration[]; - - /** - * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. - * - * @schema io.k8s.api.core.v1.PodSpec#topologySpreadConstraints - */ - readonly topologySpreadConstraints?: TopologySpreadConstraint[]; - - /** - * List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes - * - * @schema io.k8s.api.core.v1.PodSpec#volumes - */ - readonly volumes?: Volume[]; - -} - -/** - * PodTemplateSpec describes the data a pod should have when created from a template - * - * @schema io.k8s.api.core.v1.PodTemplateSpec - */ -export interface PodTemplateSpec { - /** - * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.core.v1.PodTemplateSpec#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.core.v1.PodTemplateSpec#spec - */ - readonly spec?: PodSpec; - -} - -/** - * ReplicationControllerSpec is the specification of a replication controller. - * - * @schema io.k8s.api.core.v1.ReplicationControllerSpec - */ -export interface ReplicationControllerSpec { - /** - * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) - * - * @default 0 (pod will be considered available as soon as it is ready) - * @schema io.k8s.api.core.v1.ReplicationControllerSpec#minReadySeconds - */ - readonly minReadySeconds?: number; - - /** - * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller - * - * @default 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller - * @schema io.k8s.api.core.v1.ReplicationControllerSpec#replicas - */ - readonly replicas?: number; - - /** - * Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - * - * @schema io.k8s.api.core.v1.ReplicationControllerSpec#selector - */ - readonly selector?: { [key: string]: string }; - - /** - * Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template - * - * @schema io.k8s.api.core.v1.ReplicationControllerSpec#template - */ - readonly template?: PodTemplateSpec; - -} - -/** - * ResourceQuotaSpec defines the desired hard limits to enforce for Quota. - * - * @schema io.k8s.api.core.v1.ResourceQuotaSpec - */ -export interface ResourceQuotaSpec { - /** - * hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ - * - * @schema io.k8s.api.core.v1.ResourceQuotaSpec#hard - */ - readonly hard?: { [key: string]: Quantity }; - - /** - * scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. - * - * @schema io.k8s.api.core.v1.ResourceQuotaSpec#scopeSelector - */ - readonly scopeSelector?: ScopeSelector; - - /** - * A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. - * - * @schema io.k8s.api.core.v1.ResourceQuotaSpec#scopes - */ - readonly scopes?: string[]; - -} - -/** - * ServiceSpec describes the attributes that a user creates on a service. - * - * @schema io.k8s.api.core.v1.ServiceSpec - */ -export interface ServiceSpec { - /** - * clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - * - * @schema io.k8s.api.core.v1.ServiceSpec#clusterIP - */ - readonly clusterIP?: string; - - /** - * externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. - * - * @schema io.k8s.api.core.v1.ServiceSpec#externalIPs - */ - readonly externalIPs?: string[]; - - /** - * externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName. - * - * @schema io.k8s.api.core.v1.ServiceSpec#externalName - */ - readonly externalName?: string; - - /** - * externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. - * - * @schema io.k8s.api.core.v1.ServiceSpec#externalTrafficPolicy - */ - readonly externalTrafficPolicy?: string; - - /** - * healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. - * - * @schema io.k8s.api.core.v1.ServiceSpec#healthCheckNodePort - */ - readonly healthCheckNodePort?: number; - - /** - * ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster's primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment. - * - * @schema io.k8s.api.core.v1.ServiceSpec#ipFamily - */ - readonly ipFamily?: string; - - /** - * Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. - * - * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerIP - */ - readonly loadBalancerIP?: string; - - /** - * If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ - * - * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerSourceRanges - */ - readonly loadBalancerSourceRanges?: string[]; - - /** - * The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - * - * @schema io.k8s.api.core.v1.ServiceSpec#ports - */ - readonly ports?: ServicePort[]; - - /** - * publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. - * - * @schema io.k8s.api.core.v1.ServiceSpec#publishNotReadyAddresses - */ - readonly publishNotReadyAddresses?: boolean; - - /** - * Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ - * - * @schema io.k8s.api.core.v1.ServiceSpec#selector - */ - readonly selector?: { [key: string]: string }; - - /** - * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - * - * @default None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - * @schema io.k8s.api.core.v1.ServiceSpec#sessionAffinity - */ - readonly sessionAffinity?: string; - - /** - * sessionAffinityConfig contains the configurations of session affinity. - * - * @schema io.k8s.api.core.v1.ServiceSpec#sessionAffinityConfig - */ - readonly sessionAffinityConfig?: SessionAffinityConfig; - - /** - * topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. - * - * @schema io.k8s.api.core.v1.ServiceSpec#topologyKeys - */ - readonly topologyKeys?: string[]; - - /** - * type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types - * - * @default ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types - * @schema io.k8s.api.core.v1.ServiceSpec#type - */ - readonly type?: string; - -} - -/** - * LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - * - * @schema io.k8s.api.core.v1.LocalObjectReference - */ -export interface LocalObjectReference { - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.LocalObjectReference#name - */ - readonly name?: string; - -} - -/** - * Endpoint represents a single logical "backend" implementing a service. - * - * @schema io.k8s.api.discovery.v1beta1.Endpoint - */ -export interface Endpoint { - /** - * addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. - * - * @schema io.k8s.api.discovery.v1beta1.Endpoint#addresses - */ - readonly addresses: string[]; - - /** - * conditions contains information about the current status of the endpoint. - * - * @schema io.k8s.api.discovery.v1beta1.Endpoint#conditions - */ - readonly conditions?: EndpointConditions; - - /** - * hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must pass DNS Label (RFC 1123) validation. - * - * @schema io.k8s.api.discovery.v1beta1.Endpoint#hostname - */ - readonly hostname?: string; - - /** - * targetRef is a reference to a Kubernetes object that represents this endpoint. - * - * @schema io.k8s.api.discovery.v1beta1.Endpoint#targetRef - */ - readonly targetRef?: ObjectReference; - - /** - * topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node - where the endpoint is located. This should match the corresponding - node label. -* topology.kubernetes.io/zone: the value indicates the zone where the - endpoint is located. This should match the corresponding node label. -* topology.kubernetes.io/region: the value indicates the region where the - endpoint is located. This should match the corresponding node label. - * - * @schema io.k8s.api.discovery.v1beta1.Endpoint#topology - */ - readonly topology?: { [key: string]: string }; - -} - -/** - * EndpointPort is a tuple that describes a single port. - * - * @schema io.k8s.api.core.v1.EndpointPort - */ -export interface EndpointPort { - /** - * The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. - * - * @schema io.k8s.api.core.v1.EndpointPort#name - */ - readonly name?: string; - - /** - * The port number of the endpoint. - * - * @schema io.k8s.api.core.v1.EndpointPort#port - */ - readonly port: number; - - /** - * The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. - * - * @default TCP. - * @schema io.k8s.api.core.v1.EndpointPort#protocol - */ - readonly protocol?: string; - -} - -/** - * IngressSpec describes the Ingress the user wishes to exist. - * - * @schema io.k8s.api.networking.v1beta1.IngressSpec - */ -export interface IngressSpec { - /** - * A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. - * - * @schema io.k8s.api.networking.v1beta1.IngressSpec#backend - */ - readonly backend?: IngressBackend; - - /** - * A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. - * - * @schema io.k8s.api.networking.v1beta1.IngressSpec#rules - */ - readonly rules?: IngressRule[]; - - /** - * TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. - * - * @schema io.k8s.api.networking.v1beta1.IngressSpec#tls - */ - readonly tls?: IngressTls[]; - -} - -/** - * NetworkPolicySpec provides the specification of a NetworkPolicy - * - * @schema io.k8s.api.networking.v1.NetworkPolicySpec - */ -export interface NetworkPolicySpec { - /** - * List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 - * - * @schema io.k8s.api.networking.v1.NetworkPolicySpec#egress - */ - readonly egress?: NetworkPolicyEgressRule[]; - - /** - * List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) - * - * @schema io.k8s.api.networking.v1.NetworkPolicySpec#ingress - */ - readonly ingress?: NetworkPolicyIngressRule[]; - - /** - * Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. - * - * @schema io.k8s.api.networking.v1.NetworkPolicySpec#podSelector - */ - readonly podSelector: LabelSelector; - - /** - * List of rule types that the NetworkPolicy relates to. Valid options are "Ingress", "Egress", or "Ingress,Egress". If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 - * - * @schema io.k8s.api.networking.v1.NetworkPolicySpec#policyTypes - */ - readonly policyTypes?: string[]; - -} - -/** - * PodSecurityPolicySpec defines the policy enforced. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec - */ -export interface PodSecurityPolicySpec { - /** - * allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowPrivilegeEscalation - */ - readonly allowPrivilegeEscalation?: boolean; - - /** - * AllowedCSIDrivers is a whitelist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is an alpha field, and is only honored if the API server enables the CSIInlineVolume feature gate. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedCSIDrivers - */ - readonly allowedCSIDrivers?: AllowedCsiDriver[]; - - /** - * allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedCapabilities - */ - readonly allowedCapabilities?: string[]; - - /** - * allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedFlexVolumes - */ - readonly allowedFlexVolumes?: AllowedFlexVolume[]; - - /** - * allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedHostPaths - */ - readonly allowedHostPaths?: AllowedHostPath[]; - - /** - * AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedProcMountTypes - */ - readonly allowedProcMountTypes?: string[]; - - /** - * allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. - -Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedUnsafeSysctls - */ - readonly allowedUnsafeSysctls?: string[]; - - /** - * defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#defaultAddCapabilities - */ - readonly defaultAddCapabilities?: string[]; - - /** - * defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#defaultAllowPrivilegeEscalation - */ - readonly defaultAllowPrivilegeEscalation?: boolean; - - /** - * forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. - -Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#forbiddenSysctls - */ - readonly forbiddenSysctls?: string[]; - - /** - * fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#fsGroup - */ - readonly fsGroup: FsGroupStrategyOptions; - - /** - * hostIPC determines if the policy allows the use of HostIPC in the pod spec. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostIPC - */ - readonly hostIPC?: boolean; - - /** - * hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostNetwork - */ - readonly hostNetwork?: boolean; - - /** - * hostPID determines if the policy allows the use of HostPID in the pod spec. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostPID - */ - readonly hostPID?: boolean; - - /** - * hostPorts determines which host port ranges are allowed to be exposed. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostPorts - */ - readonly hostPorts?: HostPortRange[]; - - /** - * privileged determines if a pod can request to be run as privileged. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#privileged - */ - readonly privileged?: boolean; - - /** - * readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#readOnlyRootFilesystem - */ - readonly readOnlyRootFilesystem?: boolean; - - /** - * requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#requiredDropCapabilities - */ - readonly requiredDropCapabilities?: string[]; - - /** - * RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runAsGroup - */ - readonly runAsGroup?: RunAsGroupStrategyOptions; - - /** - * runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runAsUser - */ - readonly runAsUser: RunAsUserStrategyOptions; - - /** - * runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runtimeClass - */ - readonly runtimeClass?: RuntimeClassStrategyOptions; - - /** - * seLinux is the strategy that will dictate the allowable labels that may be set. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#seLinux - */ - readonly seLinux: SeLinuxStrategyOptions; - - /** - * supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#supplementalGroups - */ - readonly supplementalGroups: SupplementalGroupsStrategyOptions; - - /** - * volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'. - * - * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#volumes - */ - readonly volumes?: string[]; - -} - -/** - * FlowSchemaSpec describes how the FlowSchema's specification looks like. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec - */ -export interface FlowSchemaSpec { - /** - * `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#distinguisherMethod - */ - readonly distinguisherMethod?: FlowDistinguisherMethod; - - /** - * `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be non-negative. Note that if the precedence is not specified or zero, it will be set to 1000 as default. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#matchingPrecedence - */ - readonly matchingPrecedence?: number; - - /** - * `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#priorityLevelConfiguration - */ - readonly priorityLevelConfiguration: PriorityLevelConfigurationReference; - - /** - * `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowSchemaSpec#rules - */ - readonly rules?: PolicyRulesWithSubjects[]; - -} - -/** - * PriorityLevelConfigurationSpec specifies the configuration of a priority level. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationSpec - */ -export interface PriorityLevelConfigurationSpec { - /** - * `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationSpec#limited - */ - readonly limited?: LimitedPriorityLevelConfiguration; - - /** - * `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationSpec#type - */ - readonly type: string; - -} - -/** - * Overhead structure represents the resource overhead associated with running a pod. - * - * @schema io.k8s.api.node.v1beta1.Overhead - */ -export interface Overhead { - /** - * PodFixed represents the fixed resource overhead associated with running a pod. - * - * @schema io.k8s.api.node.v1beta1.Overhead#podFixed - */ - readonly podFixed?: { [key: string]: Quantity }; - -} - -/** - * Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. - * - * @schema io.k8s.api.node.v1beta1.Scheduling - */ -export interface Scheduling { - /** - * nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. - * - * @schema io.k8s.api.node.v1beta1.Scheduling#nodeSelector - */ - readonly nodeSelector?: { [key: string]: string }; - - /** - * tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. - * - * @schema io.k8s.api.node.v1beta1.Scheduling#tolerations - */ - readonly tolerations?: Toleration[]; - -} - -/** - * DeleteOptions may be provided when deleting an API object. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions - */ -export interface DeleteOptions { - /** - * APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#apiVersion - */ - readonly apiVersion?: string; - - /** - * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#dryRun - */ - readonly dryRun?: string[]; - - /** - * The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. - * - * @default a per object value if not specified. zero means delete immediately. - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#gracePeriodSeconds - */ - readonly gracePeriodSeconds?: number; - - /** - * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#kind - */ - readonly kind?: IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind; - - /** - * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#orphanDependents - */ - readonly orphanDependents?: boolean; - - /** - * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#preconditions - */ - readonly preconditions?: Preconditions; - - /** - * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#propagationPolicy - */ - readonly propagationPolicy?: string; - -} - -/** - * PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec - */ -export interface PodDisruptionBudgetSpec { - /** - * An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#maxUnavailable - */ - readonly maxUnavailable?: IntOrString; - - /** - * An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#minAvailable - */ - readonly minAvailable?: IntOrString; - - /** - * Label query over pods whose evictions are managed by the disruption budget. - * - * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#selector - */ - readonly selector?: LabelSelector; - -} - -/** - * AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole - * - * @schema io.k8s.api.rbac.v1.AggregationRule - */ -export interface AggregationRule { - /** - * ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added - * - * @schema io.k8s.api.rbac.v1.AggregationRule#clusterRoleSelectors - */ - readonly clusterRoleSelectors?: LabelSelector[]; - -} - -/** - * PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. - * - * @schema io.k8s.api.rbac.v1.PolicyRule - */ -export interface PolicyRule { - /** - * APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. - * - * @schema io.k8s.api.rbac.v1.PolicyRule#apiGroups - */ - readonly apiGroups?: string[]; - - /** - * NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. - * - * @schema io.k8s.api.rbac.v1.PolicyRule#nonResourceURLs - */ - readonly nonResourceURLs?: string[]; - - /** - * ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. - * - * @schema io.k8s.api.rbac.v1.PolicyRule#resourceNames - */ - readonly resourceNames?: string[]; - - /** - * Resources is a list of resources this rule applies to. ResourceAll represents all resources. - * - * @schema io.k8s.api.rbac.v1.PolicyRule#resources - */ - readonly resources?: string[]; - - /** - * Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. - * - * @schema io.k8s.api.rbac.v1.PolicyRule#verbs - */ - readonly verbs: string[]; - -} - -/** - * RoleRef contains information that points to the role being used - * - * @schema io.k8s.api.rbac.v1.RoleRef - */ -export interface RoleRef { - /** - * APIGroup is the group for the resource being referenced - * - * @schema io.k8s.api.rbac.v1.RoleRef#apiGroup - */ - readonly apiGroup: string; - - /** - * Kind is the type of resource being referenced - * - * @schema io.k8s.api.rbac.v1.RoleRef#kind - */ - readonly kind: string; - - /** - * Name is the name of resource being referenced - * - * @schema io.k8s.api.rbac.v1.RoleRef#name - */ - readonly name: string; - -} - -/** - * Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. - * - * @schema io.k8s.api.rbac.v1.Subject - */ -export interface Subject { - /** - * APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. - * - * @default for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. - * @schema io.k8s.api.rbac.v1.Subject#apiGroup - */ - readonly apiGroup?: string; - - /** - * Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. - * - * @schema io.k8s.api.rbac.v1.Subject#kind - */ - readonly kind: string; - - /** - * Name of the object being referenced. - * - * @schema io.k8s.api.rbac.v1.Subject#name - */ - readonly name: string; - - /** - * Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. - * - * @schema io.k8s.api.rbac.v1.Subject#namespace - */ - readonly namespace?: string; - -} - -/** - * PodPresetSpec is a description of a pod preset. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec - */ -export interface PodPresetSpec { - /** - * Env defines the collection of EnvVar to inject into containers. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#env - */ - readonly env?: EnvVar[]; - - /** - * EnvFrom defines the collection of EnvFromSource to inject into containers. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#envFrom - */ - readonly envFrom?: EnvFromSource[]; - - /** - * Selector is a label query over a set of resources, in this case pods. Required. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#selector - */ - readonly selector?: LabelSelector; - - /** - * VolumeMounts defines the collection of VolumeMount to inject into containers. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#volumeMounts - */ - readonly volumeMounts?: VolumeMount[]; - - /** - * Volumes defines the collection of Volume to inject into the pod. - * - * @schema io.k8s.api.settings.v1alpha1.PodPresetSpec#volumes - */ - readonly volumes?: Volume[]; - -} - -/** - * CSINodeSpec holds information about the specification of all CSI drivers installed on a node - * - * @schema io.k8s.api.storage.v1.CSINodeSpec - */ -export interface CsiNodeSpec { - /** - * drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. - * - * @schema io.k8s.api.storage.v1.CSINodeSpec#drivers - */ - readonly drivers: CsiNodeDriver[]; - -} - -/** - * A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. - * - * @schema io.k8s.api.core.v1.TopologySelectorTerm - */ -export interface TopologySelectorTerm { - /** - * A list of topology selector requirements by labels. - * - * @schema io.k8s.api.core.v1.TopologySelectorTerm#matchLabelExpressions - */ - readonly matchLabelExpressions?: TopologySelectorLabelRequirement[]; - -} - -/** - * VolumeAttachmentSpec is the specification of a VolumeAttachment request. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec - */ -export interface VolumeAttachmentSpec { - /** - * Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#attacher - */ - readonly attacher: string; - - /** - * The node that the volume should be attached to. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#nodeName - */ - readonly nodeName: string; - - /** - * Source represents the volume that should be attached. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#source - */ - readonly source: VolumeAttachmentSource; - -} - -/** - * CSIDriverSpec is the specification of a CSIDriver. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec - */ -export interface CsiDriverSpec { - /** - * attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#attachRequired - */ - readonly attachRequired?: boolean; - - /** - * If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume - defined by a CSIVolumeSource, otherwise "false" - -"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. - * - * @default false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume - * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#podInfoOnMount - */ - readonly podInfoOnMount?: boolean; - - /** - * VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. - * - * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#volumeLifecycleModes - */ - readonly volumeLifecycleModes?: string[]; - -} - -/** - * CustomResourceDefinitionSpec describes how a user wants their resource to appear - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec - */ -export interface CustomResourceDefinitionSpec { - /** - * conversion defines conversion settings for the CRD. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#conversion - */ - readonly conversion?: CustomResourceConversion; - - /** - * group is the API group of the defined custom resource. The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#group - */ - readonly group: string; - - /** - * names specify the resource and kind names for the custom resource. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#names - */ - readonly names: CustomResourceDefinitionNames; - - /** - * preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#preserveUnknownFields - */ - readonly preserveUnknownFields?: boolean; - - /** - * scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#scope - */ - readonly scope: string; - - /** - * versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#versions - */ - readonly versions: CustomResourceDefinitionVersion[]; - -} - -/** - * StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails - */ -export interface StatusDetails { - /** - * The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#causes - */ - readonly causes?: StatusCause[]; - - /** - * The group attribute of the resource associated with the status StatusReason. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#group - */ - readonly group?: string; - - /** - * The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#kind - */ - readonly kind?: string; - - /** - * The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#name - */ - readonly name?: string; - - /** - * If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#retryAfterSeconds - */ - readonly retryAfterSeconds?: number; - - /** - * UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#uid - */ - readonly uid?: string; - -} - -/** - * APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec - */ -export interface ApiServiceSpec { - /** - * CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#caBundle - */ - readonly caBundle?: string; - - /** - * Group is the API group name this server hosts - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#group - */ - readonly group?: string; - - /** - * GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#groupPriorityMinimum - */ - readonly groupPriorityMinimum: number; - - /** - * InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#insecureSkipTLSVerify - */ - readonly insecureSkipTLSVerify?: boolean; - - /** - * Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#service - */ - readonly service: ServiceReference; - - /** - * Version is the API version this server hosts. For example, "v1" - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#version - */ - readonly version?: string; - - /** - * VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. - * - * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#versionPriority - */ - readonly versionPriority: number; - -} - -/** - * ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry - */ -export interface ManagedFieldsEntry { - /** - * APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#apiVersion - */ - readonly apiVersion?: string; - - /** - * FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#fieldsType - */ - readonly fieldsType?: string; - - /** - * FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#fieldsV1 - */ - readonly fieldsV1?: any; - - /** - * Manager is an identifier of the workflow managing these fields. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#manager - */ - readonly manager?: string; - - /** - * Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#operation - */ - readonly operation?: string; - - /** - * Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#time - */ - readonly time?: Date; - -} - -/** - * OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference - */ -export interface OwnerReference { - /** - * API version of the referent. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#apiVersion - */ - readonly apiVersion: string; - - /** - * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. - * - * @default false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#blockOwnerDeletion - */ - readonly blockOwnerDeletion?: boolean; - - /** - * If true, this reference points to the managing controller. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#controller - */ - readonly controller?: boolean; - - /** - * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#kind - */ - readonly kind: string; - - /** - * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#name - */ - readonly name: string; - - /** - * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#uid - */ - readonly uid: string; - -} - -/** - * WebhookClientConfig contains the information to make a TLS connection with the webhook - * - * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig - */ -export interface WebhookClientConfig { - /** - * `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. - * - * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#caBundle - */ - readonly caBundle?: string; - - /** - * `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. - -If the webhook is running within the cluster, then you should use `service`. - * - * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#service - */ - readonly service?: ServiceReference; - - /** - * `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. - -The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. - -Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. - -The scheme must be "https"; the URL must begin with "https://". - -A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. - -Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. - * - * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#url - */ - readonly url?: string; - -} - -/** - * A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector - */ -export interface LabelSelector { - /** - * matchExpressions is a list of label selector requirements. The requirements are ANDed. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector#matchExpressions - */ - readonly matchExpressions?: LabelSelectorRequirement[]; - - /** - * matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector#matchLabels - */ - readonly matchLabels?: { [key: string]: string }; - -} - -/** - * RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. - * - * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations - */ -export interface RuleWithOperations { - /** - * APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. - * - * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#apiGroups - */ - readonly apiGroups?: string[]; - - /** - * APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. - * - * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#apiVersions - */ - readonly apiVersions?: string[]; - - /** - * Operations is the operations the admission hook cares about - CREATE, UPDATE, or * for all operations. If '*' is present, the length of the slice must be one. Required. - * - * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#operations - */ - readonly operations?: string[]; - - /** - * Resources is a list of resources this rule applies to. - -For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. - -If wildcard is present, the validation rule will ensure resources do not overlap with each other. - -Depending on the enclosing object, subresources might not be allowed. Required. - * - * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#resources - */ - readonly resources?: string[]; - - /** - * scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". - * - * @default . - * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#scope - */ - readonly scope?: string; - -} - -/** - * DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. - * - * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy - */ -export interface DaemonSetUpdateStrategy { - /** - * Rolling update config params. Present only if type = "RollingUpdate". - * - * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy#rollingUpdate - */ - readonly rollingUpdate?: RollingUpdateDaemonSet; - - /** - * Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. - * - * @default RollingUpdate. - * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy#type - */ - readonly type?: string; - -} - -/** - * DeploymentStrategy describes how to replace existing pods with new ones. - * - * @schema io.k8s.api.apps.v1.DeploymentStrategy - */ -export interface DeploymentStrategy { - /** - * Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. - * - * @schema io.k8s.api.apps.v1.DeploymentStrategy#rollingUpdate - */ - readonly rollingUpdate?: RollingUpdateDeployment; - - /** - * Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. - * - * @default RollingUpdate. - * @schema io.k8s.api.apps.v1.DeploymentStrategy#type - */ - readonly type?: string; - -} - -/** - * StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy. - * - * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy - */ -export interface StatefulSetUpdateStrategy { - /** - * RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. - * - * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy#rollingUpdate - */ - readonly rollingUpdate?: RollingUpdateStatefulSetStrategy; - - /** - * Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. - * - * @default RollingUpdate. - * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy#type - */ - readonly type?: string; - -} - -/** - * Policy defines the configuration of how audit events are logged - * - * @schema io.k8s.api.auditregistration.v1alpha1.Policy - */ -export interface Policy { - /** - * The Level that all requests are recorded at. available options: None, Metadata, Request, RequestResponse required - * - * @schema io.k8s.api.auditregistration.v1alpha1.Policy#level - */ - readonly level: string; - - /** - * Stages is a list of stages for which events are created. - * - * @schema io.k8s.api.auditregistration.v1alpha1.Policy#stages - */ - readonly stages?: string[]; - -} - -/** - * Webhook holds the configuration of the webhook - * - * @schema io.k8s.api.auditregistration.v1alpha1.Webhook - */ -export interface Webhook { - /** - * ClientConfig holds the connection parameters for the webhook required - * - * @schema io.k8s.api.auditregistration.v1alpha1.Webhook#clientConfig - */ - readonly clientConfig: WebhookClientConfig; - - /** - * Throttle holds the options for throttling the webhook - * - * @schema io.k8s.api.auditregistration.v1alpha1.Webhook#throttle - */ - readonly throttle?: WebhookThrottleConfig; - -} - -/** - * BoundObjectReference is a reference to an object that a token is bound to. - * - * @schema io.k8s.api.authentication.v1.BoundObjectReference - */ -export interface BoundObjectReference { - /** - * API version of the referent. - * - * @schema io.k8s.api.authentication.v1.BoundObjectReference#apiVersion - */ - readonly apiVersion?: string; - - /** - * Kind of the referent. Valid kinds are 'Pod' and 'Secret'. - * - * @schema io.k8s.api.authentication.v1.BoundObjectReference#kind - */ - readonly kind?: string; - - /** - * Name of the referent. - * - * @schema io.k8s.api.authentication.v1.BoundObjectReference#name - */ - readonly name?: string; - - /** - * UID of the referent. - * - * @schema io.k8s.api.authentication.v1.BoundObjectReference#uid - */ - readonly uid?: string; - -} - -/** - * NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface - * - * @schema io.k8s.api.authorization.v1.NonResourceAttributes - */ -export interface NonResourceAttributes { - /** - * Path is the URL path of the request - * - * @schema io.k8s.api.authorization.v1.NonResourceAttributes#path - */ - readonly path?: string; - - /** - * Verb is the standard HTTP verb - * - * @schema io.k8s.api.authorization.v1.NonResourceAttributes#verb - */ - readonly verb?: string; - -} - -/** - * ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes - */ -export interface ResourceAttributes { - /** - * Group is the API Group of the Resource. "*" means all. - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#group - */ - readonly group?: string; - - /** - * Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#name - */ - readonly name?: string; - - /** - * Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#namespace - */ - readonly namespace?: string; - - /** - * Resource is one of the existing resource types. "*" means all. - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#resource - */ - readonly resource?: string; - - /** - * Subresource is one of the existing resource types. "" means none. - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#subresource - */ - readonly subresource?: string; - - /** - * Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#verb - */ - readonly verb?: string; - - /** - * Version is the API Version of the Resource. "*" means all. - * - * @schema io.k8s.api.authorization.v1.ResourceAttributes#version - */ - readonly version?: string; - -} - -/** - * CrossVersionObjectReference contains enough information to let you identify the referred resource. - * - * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference - */ -export interface CrossVersionObjectReference { - /** - * API version of the referent - * - * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#apiVersion - */ - readonly apiVersion?: string; - - /** - * Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" - * - * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#kind - */ - readonly kind: string; - - /** - * Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - * - * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#name - */ - readonly name: string; - -} - -/** - * JobTemplateSpec describes the data a Job should have when created from a template - * - * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec - */ -export interface JobTemplateSpec { - /** - * Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - * - * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec#metadata - */ - readonly metadata?: ObjectMeta; - - /** - * Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - * - * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec#spec - */ - readonly spec?: JobSpec; - -} - -/** - * EndpointAddress is a tuple that describes single IP address. - * - * @schema io.k8s.api.core.v1.EndpointAddress - */ -export interface EndpointAddress { - /** - * The Hostname of this endpoint - * - * @schema io.k8s.api.core.v1.EndpointAddress#hostname - */ - readonly hostname?: string; - - /** - * The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. - * - * @schema io.k8s.api.core.v1.EndpointAddress#ip - */ - readonly ip: string; - - /** - * Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. - * - * @schema io.k8s.api.core.v1.EndpointAddress#nodeName - */ - readonly nodeName?: string; - - /** - * Reference to object providing the endpoint. - * - * @schema io.k8s.api.core.v1.EndpointAddress#targetRef - */ - readonly targetRef?: ObjectReference; - -} - -/** - * LimitRangeItem defines a min/max usage limit for any resource that matches on kind. - * - * @schema io.k8s.api.core.v1.LimitRangeItem - */ -export interface LimitRangeItem { - /** - * Default resource requirement limit value by resource name if resource limit is omitted. - * - * @schema io.k8s.api.core.v1.LimitRangeItem#default - */ - readonly default?: { [key: string]: Quantity }; - - /** - * DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. - * - * @schema io.k8s.api.core.v1.LimitRangeItem#defaultRequest - */ - readonly defaultRequest?: { [key: string]: Quantity }; - - /** - * Max usage constraints on this kind by resource name. - * - * @schema io.k8s.api.core.v1.LimitRangeItem#max - */ - readonly max?: { [key: string]: Quantity }; - - /** - * MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. - * - * @schema io.k8s.api.core.v1.LimitRangeItem#maxLimitRequestRatio - */ - readonly maxLimitRequestRatio?: { [key: string]: Quantity }; - - /** - * Min usage constraints on this kind by resource name. - * - * @schema io.k8s.api.core.v1.LimitRangeItem#min - */ - readonly min?: { [key: string]: Quantity }; - - /** - * Type of resource that this limit applies to. - * - * @schema io.k8s.api.core.v1.LimitRangeItem#type - */ - readonly type?: string; - -} - -/** - * NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. - * - * @schema io.k8s.api.core.v1.NodeConfigSource - */ -export interface NodeConfigSource { - /** - * ConfigMap is a reference to a Node's ConfigMap - * - * @schema io.k8s.api.core.v1.NodeConfigSource#configMap - */ - readonly configMap?: ConfigMapNodeConfigSource; - -} - -/** - * The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. - * - * @schema io.k8s.api.core.v1.Taint - */ -export interface Taint { - /** - * Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. - * - * @schema io.k8s.api.core.v1.Taint#effect - */ - readonly effect: string; - - /** - * Required. The taint key to be applied to a node. - * - * @schema io.k8s.api.core.v1.Taint#key - */ - readonly key: string; - - /** - * TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. - * - * @schema io.k8s.api.core.v1.Taint#timeAdded - */ - readonly timeAdded?: Date; - - /** - * Required. The taint value corresponding to the taint key. - * - * @schema io.k8s.api.core.v1.Taint#value - */ - readonly value?: string; - -} - -/** - * Represents a Persistent Disk resource in AWS. - -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. - * - * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource - */ -export interface AwsElasticBlockStoreVolumeSource { - /** - * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - * - * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). - * - * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#partition - */ - readonly partition?: number; - - /** - * Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - * - * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - * - * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#volumeID - */ - readonly volumeID: string; - -} - -/** - * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource - */ -export interface AzureDiskVolumeSource { - /** - * Host Caching mode: None, Read Only, Read Write. - * - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#cachingMode - */ - readonly cachingMode?: string; - - /** - * The Name of the data disk in the blob storage - * - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#diskName - */ - readonly diskName: string; - - /** - * The URI the data disk in the blob storage - * - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#diskURI - */ - readonly diskURI: string; - - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared - * - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#kind - */ - readonly kind?: string; - - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#readOnly - */ - readonly readOnly?: boolean; - -} - -/** - * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource - */ -export interface AzureFilePersistentVolumeSource { - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * the name of secret that contains Azure Storage Account Name and Key - * - * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#secretName - */ - readonly secretName: string; - - /** - * the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod - * - * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#secretNamespace - */ - readonly secretNamespace?: string; - - /** - * Share Name - * - * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#shareName - */ - readonly shareName: string; - -} - -/** - * @schema io.k8s.apimachinery.pkg.api.resource.Quantity - */ -export class Quantity { - public static fromString(value: string): Quantity { - return new Quantity(value); - } - public static fromNumber(value: number): Quantity { - return new Quantity(value); - } - private constructor(value: any) { - Object.defineProperty(this, 'resolve', { value: () => value }); - } -} - -/** - * Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource - */ -export interface CephFsPersistentVolumeSource { - /** - * Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#monitors - */ - readonly monitors: string[]; - - /** - * Optional: Used as the mounted root, rather than the full Ceph tree, default is / - * - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#path - */ - readonly path?: string; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#secretFile - */ - readonly secretFile?: string; - - /** - * Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#secretRef - */ - readonly secretRef?: SecretReference; - - /** - * Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#user - */ - readonly user?: string; - -} - -/** - * Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource - */ -export interface CinderPersistentVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: points to a secret object containing parameters used to connect to OpenStack. - * - * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#secretRef - */ - readonly secretRef?: SecretReference; - - /** - * volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#volumeID - */ - readonly volumeID: string; - -} - -/** - * Represents storage that is managed by an external CSI volume driver (Beta feature) - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource - */ -export interface CsiPersistentVolumeSource { - /** - * ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#controllerExpandSecretRef - */ - readonly controllerExpandSecretRef?: SecretReference; - - /** - * ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#controllerPublishSecretRef - */ - readonly controllerPublishSecretRef?: SecretReference; - - /** - * Driver is the name of the driver to use for this volume. Required. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#driver - */ - readonly driver: string; - - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#nodePublishSecretRef - */ - readonly nodePublishSecretRef?: SecretReference; - - /** - * NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#nodeStageSecretRef - */ - readonly nodeStageSecretRef?: SecretReference; - - /** - * Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). - * - * @default false (read/write). - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Attributes of the volume to publish. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#volumeAttributes - */ - readonly volumeAttributes?: { [key: string]: string }; - - /** - * VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. - * - * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#volumeHandle - */ - readonly volumeHandle: string; - -} - -/** - * Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.FCVolumeSource - */ -export interface FcVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.FCVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Optional: FC target lun number - * - * @schema io.k8s.api.core.v1.FCVolumeSource#lun - */ - readonly lun?: number; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.FCVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: FC target worldwide names (WWNs) - * - * @schema io.k8s.api.core.v1.FCVolumeSource#targetWWNs - */ - readonly targetWWNs?: string[]; - - /** - * Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. - * - * @schema io.k8s.api.core.v1.FCVolumeSource#wwids - */ - readonly wwids?: string[]; - -} - -/** - * FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. - * - * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource - */ -export interface FlexPersistentVolumeSource { - /** - * Driver is the name of the driver to use for this volume. - * - * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#driver - */ - readonly driver: string; - - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. - * - * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Optional: Extra command options if any. - * - * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#options - */ - readonly options?: { [key: string]: string }; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. - * - * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#secretRef - */ - readonly secretRef?: SecretReference; - -} - -/** - * Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.FlockerVolumeSource - */ -export interface FlockerVolumeSource { - /** - * Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated - * - * @schema io.k8s.api.core.v1.FlockerVolumeSource#datasetName - */ - readonly datasetName?: string; - - /** - * UUID of the dataset. This is unique identifier of a Flocker dataset - * - * @schema io.k8s.api.core.v1.FlockerVolumeSource#datasetUUID - */ - readonly datasetUUID?: string; - -} - -/** - * Represents a Persistent Disk resource in Google Compute Engine. - -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. - * - * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource - */ -export interface GcePersistentDiskVolumeSource { - /** - * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * - * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * - * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#partition - */ - readonly partition?: number; - - /** - * Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * - * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#pdName - */ - readonly pdName: string; - - /** - * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * - * @default false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#readOnly - */ - readonly readOnly?: boolean; - -} - -/** - * Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource - */ -export interface GlusterfsPersistentVolumeSource { - /** - * EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#endpoints - */ - readonly endpoints: string; - - /** - * EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#endpointsNamespace - */ - readonly endpointsNamespace?: string; - - /** - * Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#path - */ - readonly path: string; - - /** - * ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @default false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - -} - -/** - * Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.HostPathVolumeSource - */ -export interface HostPathVolumeSource { - /** - * Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - * - * @schema io.k8s.api.core.v1.HostPathVolumeSource#path - */ - readonly path: string; - - /** - * Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - * - * @default More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - * @schema io.k8s.api.core.v1.HostPathVolumeSource#type - */ - readonly type?: string; - -} - -/** - * ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource - */ -export interface IscsiPersistentVolumeSource { - /** - * whether support iSCSI Discovery CHAP authentication - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#chapAuthDiscovery - */ - readonly chapAuthDiscovery?: boolean; - - /** - * whether support iSCSI Session CHAP authentication - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#chapAuthSession - */ - readonly chapAuthSession?: boolean; - - /** - * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#initiatorName - */ - readonly initiatorName?: string; - - /** - * Target iSCSI Qualified Name. - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#iqn - */ - readonly iqn: string; - - /** - * iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). - * - * @default default' (tcp). - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#iscsiInterface - */ - readonly iscsiInterface?: string; - - /** - * iSCSI Target Lun number. - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#lun - */ - readonly lun: number; - - /** - * iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#portals - */ - readonly portals?: string[]; - - /** - * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. - * - * @default false. - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * CHAP Secret for iSCSI target and initiator authentication - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#secretRef - */ - readonly secretRef?: SecretReference; - - /** - * iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - * - * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#targetPortal - */ - readonly targetPortal: string; - -} - -/** - * Local represents directly-attached storage with node affinity (Beta feature) - * - * @schema io.k8s.api.core.v1.LocalVolumeSource - */ -export interface LocalVolumeSource { - /** - * Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. - * - * @schema io.k8s.api.core.v1.LocalVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). - * - * @schema io.k8s.api.core.v1.LocalVolumeSource#path - */ - readonly path: string; - -} - -/** - * Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.NFSVolumeSource - */ -export interface NfsVolumeSource { - /** - * Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - * - * @schema io.k8s.api.core.v1.NFSVolumeSource#path - */ - readonly path: string; - - /** - * ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - * - * @default false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - * @schema io.k8s.api.core.v1.NFSVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - * - * @schema io.k8s.api.core.v1.NFSVolumeSource#server - */ - readonly server: string; - -} - -/** - * VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. - * - * @schema io.k8s.api.core.v1.VolumeNodeAffinity - */ -export interface VolumeNodeAffinity { - /** - * Required specifies hard node constraints that must be met. - * - * @schema io.k8s.api.core.v1.VolumeNodeAffinity#required - */ - readonly required?: NodeSelector; - -} - -/** - * Represents a Photon Controller persistent disk resource. - * - * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource - */ -export interface PhotonPersistentDiskVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * ID that identifies Photon Controller persistent disk - * - * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource#pdID - */ - readonly pdID: string; - -} - -/** - * PortworxVolumeSource represents a Portworx volume resource. - * - * @schema io.k8s.api.core.v1.PortworxVolumeSource - */ -export interface PortworxVolumeSource { - /** - * FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.PortworxVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.PortworxVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * VolumeID uniquely identifies a Portworx volume - * - * @schema io.k8s.api.core.v1.PortworxVolumeSource#volumeID - */ - readonly volumeID: string; - -} - -/** - * Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.QuobyteVolumeSource - */ -export interface QuobyteVolumeSource { - /** - * Group to map volume access to Default is no group - * - * @default no group - * @schema io.k8s.api.core.v1.QuobyteVolumeSource#group - */ - readonly group?: string; - - /** - * ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. - * - * @default false. - * @schema io.k8s.api.core.v1.QuobyteVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes - * - * @schema io.k8s.api.core.v1.QuobyteVolumeSource#registry - */ - readonly registry: string; - - /** - * Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin - * - * @schema io.k8s.api.core.v1.QuobyteVolumeSource#tenant - */ - readonly tenant?: string; - - /** - * User to map volume access to Defaults to serivceaccount user - * - * @default serivceaccount user - * @schema io.k8s.api.core.v1.QuobyteVolumeSource#user - */ - readonly user?: string; - - /** - * Volume is a string that references an already created Quobyte volume by name. - * - * @schema io.k8s.api.core.v1.QuobyteVolumeSource#volume - */ - readonly volume: string; - -} - -/** - * Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource - */ -export interface RbdPersistentVolumeSource { - /** - * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd - * - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#image - */ - readonly image: string; - - /** - * Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#keyring - */ - readonly keyring?: string; - - /** - * A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#monitors - */ - readonly monitors: string[]; - - /** - * The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#pool - */ - readonly pool?: string; - - /** - * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#secretRef - */ - readonly secretRef?: SecretReference; - - /** - * The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#user - */ - readonly user?: string; - -} - -/** - * ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource - */ -export interface ScaleIoPersistentVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" - * - * @default xfs" - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The host address of the ScaleIO API Gateway. - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#gateway - */ - readonly gateway: string; - - /** - * The name of the ScaleIO Protection Domain for the configured storage. - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#protectionDomain - */ - readonly protectionDomain?: string; - - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#secretRef - */ - readonly secretRef: SecretReference; - - /** - * Flag to enable/disable SSL communication with Gateway, default false - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#sslEnabled - */ - readonly sslEnabled?: boolean; - - /** - * Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. - * - * @default ThinProvisioned. - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#storageMode - */ - readonly storageMode?: string; - - /** - * The ScaleIO Storage Pool associated with the protection domain. - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#storagePool - */ - readonly storagePool?: string; - - /** - * The name of the storage system as configured in ScaleIO. - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#system - */ - readonly system: string; - - /** - * The name of a volume already created in the ScaleIO system that is associated with this volume source. - * - * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#volumeName - */ - readonly volumeName?: string; - -} - -/** - * Represents a StorageOS persistent volume resource. - * - * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource - */ -export interface StorageOsPersistentVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. - * - * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#secretRef - */ - readonly secretRef?: ObjectReference; - - /** - * VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. - * - * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#volumeName - */ - readonly volumeName?: string; - - /** - * VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. - * - * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#volumeNamespace - */ - readonly volumeNamespace?: string; - -} - -/** - * Represents a vSphere volume resource. - * - * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource - */ -export interface VsphereVirtualDiskVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. - * - * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#storagePolicyID - */ - readonly storagePolicyID?: string; - - /** - * Storage Policy Based Management (SPBM) profile name. - * - * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#storagePolicyName - */ - readonly storagePolicyName?: string; - - /** - * Path that identifies vSphere volume vmdk - * - * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#volumePath - */ - readonly volumePath: string; - -} - -/** - * TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. - * - * @schema io.k8s.api.core.v1.TypedLocalObjectReference - */ -export interface TypedLocalObjectReference { - /** - * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. - * - * @schema io.k8s.api.core.v1.TypedLocalObjectReference#apiGroup - */ - readonly apiGroup?: string; - - /** - * Kind is the type of resource being referenced - * - * @schema io.k8s.api.core.v1.TypedLocalObjectReference#kind - */ - readonly kind: string; - - /** - * Name is the name of resource being referenced - * - * @schema io.k8s.api.core.v1.TypedLocalObjectReference#name - */ - readonly name: string; - -} - -/** - * ResourceRequirements describes the compute resource requirements. - * - * @schema io.k8s.api.core.v1.ResourceRequirements - */ -export interface ResourceRequirements { - /** - * Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - * - * @schema io.k8s.api.core.v1.ResourceRequirements#limits - */ - readonly limits?: { [key: string]: Quantity }; - - /** - * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - * - * @schema io.k8s.api.core.v1.ResourceRequirements#requests - */ - readonly requests?: { [key: string]: Quantity }; - -} - -/** - * Affinity is a group of affinity scheduling rules. - * - * @schema io.k8s.api.core.v1.Affinity - */ -export interface Affinity { - /** - * Describes node affinity scheduling rules for the pod. - * - * @schema io.k8s.api.core.v1.Affinity#nodeAffinity - */ - readonly nodeAffinity?: NodeAffinity; - - /** - * Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - * - * @schema io.k8s.api.core.v1.Affinity#podAffinity - */ - readonly podAffinity?: PodAffinity; - - /** - * Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - * - * @schema io.k8s.api.core.v1.Affinity#podAntiAffinity - */ - readonly podAntiAffinity?: PodAntiAffinity; - -} - -/** - * A single application container that you want to run within a pod. - * - * @schema io.k8s.api.core.v1.Container - */ -export interface Container { - /** - * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - * - * @schema io.k8s.api.core.v1.Container#args - */ - readonly args?: string[]; - - /** - * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - * - * @schema io.k8s.api.core.v1.Container#command - */ - readonly command?: string[]; - - /** - * List of environment variables to set in the container. Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#env - */ - readonly env?: EnvVar[]; - - /** - * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#envFrom - */ - readonly envFrom?: EnvFromSource[]; - - /** - * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. - * - * @schema io.k8s.api.core.v1.Container#image - */ - readonly image?: string; - - /** - * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - * - * @default Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - * @schema io.k8s.api.core.v1.Container#imagePullPolicy - */ - readonly imagePullPolicy?: string; - - /** - * Actions that the management system should take in response to container lifecycle events. Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#lifecycle - */ - readonly lifecycle?: Lifecycle; - - /** - * Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * - * @schema io.k8s.api.core.v1.Container#livenessProbe - */ - readonly livenessProbe?: Probe; - - /** - * Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#name - */ - readonly name: string; - - /** - * List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#ports - */ - readonly ports?: ContainerPort[]; - - /** - * Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * - * @schema io.k8s.api.core.v1.Container#readinessProbe - */ - readonly readinessProbe?: Probe; - - /** - * Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - * - * @schema io.k8s.api.core.v1.Container#resources - */ - readonly resources?: ResourceRequirements; - - /** - * Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - * - * @schema io.k8s.api.core.v1.Container#securityContext - */ - readonly securityContext?: SecurityContext; - - /** - * StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * - * @schema io.k8s.api.core.v1.Container#startupProbe - */ - readonly startupProbe?: Probe; - - /** - * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. - * - * @default false. - * @schema io.k8s.api.core.v1.Container#stdin - */ - readonly stdin?: boolean; - - /** - * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false - * - * @default false - * @schema io.k8s.api.core.v1.Container#stdinOnce - */ - readonly stdinOnce?: boolean; - - /** - * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. - * - * @default dev/termination-log. Cannot be updated. - * @schema io.k8s.api.core.v1.Container#terminationMessagePath - */ - readonly terminationMessagePath?: string; - - /** - * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. - * - * @default File. Cannot be updated. - * @schema io.k8s.api.core.v1.Container#terminationMessagePolicy - */ - readonly terminationMessagePolicy?: string; - - /** - * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. - * - * @default false. - * @schema io.k8s.api.core.v1.Container#tty - */ - readonly tty?: boolean; - - /** - * volumeDevices is the list of block devices to be used by the container. This is a beta feature. - * - * @schema io.k8s.api.core.v1.Container#volumeDevices - */ - readonly volumeDevices?: VolumeDevice[]; - - /** - * Pod volumes to mount into the container's filesystem. Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#volumeMounts - */ - readonly volumeMounts?: VolumeMount[]; - - /** - * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - * - * @schema io.k8s.api.core.v1.Container#workingDir - */ - readonly workingDir?: string; - -} - -/** - * PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. - * - * @schema io.k8s.api.core.v1.PodDNSConfig - */ -export interface PodDnsConfig { - /** - * A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. - * - * @schema io.k8s.api.core.v1.PodDNSConfig#nameservers - */ - readonly nameservers?: string[]; - - /** - * A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. - * - * @schema io.k8s.api.core.v1.PodDNSConfig#options - */ - readonly options?: PodDnsConfigOption[]; - - /** - * A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. - * - * @schema io.k8s.api.core.v1.PodDNSConfig#searches - */ - readonly searches?: string[]; - -} - -/** - * An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. - * - * @schema io.k8s.api.core.v1.EphemeralContainer - */ -export interface EphemeralContainer { - /** - * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - * - * @schema io.k8s.api.core.v1.EphemeralContainer#args - */ - readonly args?: string[]; - - /** - * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - * - * @schema io.k8s.api.core.v1.EphemeralContainer#command - */ - readonly command?: string[]; - - /** - * List of environment variables to set in the container. Cannot be updated. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#env - */ - readonly env?: EnvVar[]; - - /** - * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#envFrom - */ - readonly envFrom?: EnvFromSource[]; - - /** - * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images - * - * @schema io.k8s.api.core.v1.EphemeralContainer#image - */ - readonly image?: string; - - /** - * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - * - * @default Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - * @schema io.k8s.api.core.v1.EphemeralContainer#imagePullPolicy - */ - readonly imagePullPolicy?: string; - - /** - * Lifecycle is not allowed for ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#lifecycle - */ - readonly lifecycle?: Lifecycle; - - /** - * Probes are not allowed for ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#livenessProbe - */ - readonly livenessProbe?: Probe; - - /** - * Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#name - */ - readonly name: string; - - /** - * Ports are not allowed for ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#ports - */ - readonly ports?: ContainerPort[]; - - /** - * Probes are not allowed for ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#readinessProbe - */ - readonly readinessProbe?: Probe; - - /** - * Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#resources - */ - readonly resources?: ResourceRequirements; - - /** - * SecurityContext is not allowed for ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#securityContext - */ - readonly securityContext?: SecurityContext; - - /** - * Probes are not allowed for ephemeral containers. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#startupProbe - */ - readonly startupProbe?: Probe; - - /** - * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. - * - * @default false. - * @schema io.k8s.api.core.v1.EphemeralContainer#stdin - */ - readonly stdin?: boolean; - - /** - * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false - * - * @default false - * @schema io.k8s.api.core.v1.EphemeralContainer#stdinOnce - */ - readonly stdinOnce?: boolean; - - /** - * If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#targetContainerName - */ - readonly targetContainerName?: string; - - /** - * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. - * - * @default dev/termination-log. Cannot be updated. - * @schema io.k8s.api.core.v1.EphemeralContainer#terminationMessagePath - */ - readonly terminationMessagePath?: string; - - /** - * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. - * - * @default File. Cannot be updated. - * @schema io.k8s.api.core.v1.EphemeralContainer#terminationMessagePolicy - */ - readonly terminationMessagePolicy?: string; - - /** - * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. - * - * @default false. - * @schema io.k8s.api.core.v1.EphemeralContainer#tty - */ - readonly tty?: boolean; - - /** - * volumeDevices is the list of block devices to be used by the container. This is a beta feature. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#volumeDevices - */ - readonly volumeDevices?: VolumeDevice[]; - - /** - * Pod volumes to mount into the container's filesystem. Cannot be updated. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#volumeMounts - */ - readonly volumeMounts?: VolumeMount[]; - - /** - * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - * - * @schema io.k8s.api.core.v1.EphemeralContainer#workingDir - */ - readonly workingDir?: string; - -} - -/** - * HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. - * - * @schema io.k8s.api.core.v1.HostAlias - */ -export interface HostAlias { - /** - * Hostnames for the above IP address. - * - * @schema io.k8s.api.core.v1.HostAlias#hostnames - */ - readonly hostnames?: string[]; - - /** - * IP address of the host file entry. - * - * @schema io.k8s.api.core.v1.HostAlias#ip - */ - readonly ip?: string; - -} - -/** - * PodReadinessGate contains the reference to a pod condition - * - * @schema io.k8s.api.core.v1.PodReadinessGate - */ -export interface PodReadinessGate { - /** - * ConditionType refers to a condition in the pod's condition list with matching type. - * - * @schema io.k8s.api.core.v1.PodReadinessGate#conditionType - */ - readonly conditionType: string; - -} - -/** - * PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. - * - * @schema io.k8s.api.core.v1.PodSecurityContext - */ -export interface PodSecurityContext { - /** - * 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: - -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---- - -If unset, the Kubelet will not modify the ownership and permissions of any volume. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#fsGroup - */ - readonly fsGroup?: number; - - /** - * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#runAsGroup - */ - readonly runAsGroup?: number; - - /** - * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#runAsNonRoot - */ - readonly runAsNonRoot?: boolean; - - /** - * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - * - * @default user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - * @schema io.k8s.api.core.v1.PodSecurityContext#runAsUser - */ - readonly runAsUser?: number; - - /** - * The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#seLinuxOptions - */ - readonly seLinuxOptions?: SeLinuxOptions; - - /** - * A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#supplementalGroups - */ - readonly supplementalGroups?: number[]; - - /** - * Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#sysctls - */ - readonly sysctls?: Sysctl[]; - - /** - * The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @schema io.k8s.api.core.v1.PodSecurityContext#windowsOptions - */ - readonly windowsOptions?: WindowsSecurityContextOptions; - -} - -/** - * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . - * - * @schema io.k8s.api.core.v1.Toleration - */ -export interface Toleration { - /** - * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. - * - * @schema io.k8s.api.core.v1.Toleration#effect - */ - readonly effect?: string; - - /** - * Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. - * - * @schema io.k8s.api.core.v1.Toleration#key - */ - readonly key?: string; - - /** - * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. - * - * @default Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. - * @schema io.k8s.api.core.v1.Toleration#operator - */ - readonly operator?: string; - - /** - * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. - * - * @schema io.k8s.api.core.v1.Toleration#tolerationSeconds - */ - readonly tolerationSeconds?: number; - - /** - * Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. - * - * @schema io.k8s.api.core.v1.Toleration#value - */ - readonly value?: string; - -} - -/** - * TopologySpreadConstraint specifies how to spread matching pods among the given topology. - * - * @schema io.k8s.api.core.v1.TopologySpreadConstraint - */ -export interface TopologySpreadConstraint { - /** - * LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. - * - * @schema io.k8s.api.core.v1.TopologySpreadConstraint#labelSelector - */ - readonly labelSelector?: LabelSelector; - - /** - * MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It's a required field. Default value is 1 and 0 is not allowed. - * - * @schema io.k8s.api.core.v1.TopologySpreadConstraint#maxSkew - */ - readonly maxSkew: number; - - /** - * TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. - * - * @schema io.k8s.api.core.v1.TopologySpreadConstraint#topologyKey - */ - readonly topologyKey: string; - - /** - * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as "Unsatisfiable" if and only if placing incoming pod on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. - * - * @schema io.k8s.api.core.v1.TopologySpreadConstraint#whenUnsatisfiable - */ - readonly whenUnsatisfiable: string; - -} - -/** - * Volume represents a named volume in a pod that may be accessed by any container in the pod. - * - * @schema io.k8s.api.core.v1.Volume - */ -export interface Volume { - /** - * AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - * - * @schema io.k8s.api.core.v1.Volume#awsElasticBlockStore - */ - readonly awsElasticBlockStore?: AwsElasticBlockStoreVolumeSource; - - /** - * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.Volume#azureDisk - */ - readonly azureDisk?: AzureDiskVolumeSource; - - /** - * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.Volume#azureFile - */ - readonly azureFile?: AzureFileVolumeSource; - - /** - * CephFS represents a Ceph FS mount on the host that shares a pod's lifetime - * - * @schema io.k8s.api.core.v1.Volume#cephfs - */ - readonly cephfs?: CephFsVolumeSource; - - /** - * Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @schema io.k8s.api.core.v1.Volume#cinder - */ - readonly cinder?: CinderVolumeSource; - - /** - * ConfigMap represents a configMap that should populate this volume - * - * @schema io.k8s.api.core.v1.Volume#configMap - */ - readonly configMap?: ConfigMapVolumeSource; - - /** - * CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). - * - * @schema io.k8s.api.core.v1.Volume#csi - */ - readonly csi?: CsiVolumeSource; - - /** - * DownwardAPI represents downward API about the pod that should populate this volume - * - * @schema io.k8s.api.core.v1.Volume#downwardAPI - */ - readonly downwardAPI?: DownwardApiVolumeSource; - - /** - * EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - * - * @schema io.k8s.api.core.v1.Volume#emptyDir - */ - readonly emptyDir?: EmptyDirVolumeSource; - - /** - * FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - * - * @schema io.k8s.api.core.v1.Volume#fc - */ - readonly fc?: FcVolumeSource; - - /** - * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. - * - * @schema io.k8s.api.core.v1.Volume#flexVolume - */ - readonly flexVolume?: FlexVolumeSource; - - /** - * Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - * - * @schema io.k8s.api.core.v1.Volume#flocker - */ - readonly flocker?: FlockerVolumeSource; - - /** - * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - * - * @schema io.k8s.api.core.v1.Volume#gcePersistentDisk - */ - readonly gcePersistentDisk?: GcePersistentDiskVolumeSource; - - /** - * GitRepo represents a git repository at a particular revision. 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. - * - * @schema io.k8s.api.core.v1.Volume#gitRepo - */ - readonly gitRepo?: GitRepoVolumeSource; - - /** - * Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md - * - * @schema io.k8s.api.core.v1.Volume#glusterfs - */ - readonly glusterfs?: GlusterfsVolumeSource; - - /** - * HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - * - * @schema io.k8s.api.core.v1.Volume#hostPath - */ - readonly hostPath?: HostPathVolumeSource; - - /** - * ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md - * - * @schema io.k8s.api.core.v1.Volume#iscsi - */ - readonly iscsi?: IscsiVolumeSource; - - /** - * Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.Volume#name - */ - readonly name: string; - - /** - * NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - * - * @schema io.k8s.api.core.v1.Volume#nfs - */ - readonly nfs?: NfsVolumeSource; - - /** - * PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - * - * @schema io.k8s.api.core.v1.Volume#persistentVolumeClaim - */ - readonly persistentVolumeClaim?: PersistentVolumeClaimVolumeSource; - - /** - * PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - * - * @schema io.k8s.api.core.v1.Volume#photonPersistentDisk - */ - readonly photonPersistentDisk?: PhotonPersistentDiskVolumeSource; - - /** - * PortworxVolume represents a portworx volume attached and mounted on kubelets host machine - * - * @schema io.k8s.api.core.v1.Volume#portworxVolume - */ - readonly portworxVolume?: PortworxVolumeSource; - - /** - * Items for all in one resources secrets, configmaps, and downward API - * - * @schema io.k8s.api.core.v1.Volume#projected - */ - readonly projected?: ProjectedVolumeSource; - - /** - * Quobyte represents a Quobyte mount on the host that shares a pod's lifetime - * - * @schema io.k8s.api.core.v1.Volume#quobyte - */ - readonly quobyte?: QuobyteVolumeSource; - - /** - * RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md - * - * @schema io.k8s.api.core.v1.Volume#rbd - */ - readonly rbd?: RbdVolumeSource; - - /** - * ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - * - * @schema io.k8s.api.core.v1.Volume#scaleIO - */ - readonly scaleIO?: ScaleIoVolumeSource; - - /** - * Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - * - * @schema io.k8s.api.core.v1.Volume#secret - */ - readonly secret?: SecretVolumeSource; - - /** - * StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. - * - * @schema io.k8s.api.core.v1.Volume#storageos - */ - readonly storageos?: StorageOsVolumeSource; - - /** - * VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - * - * @schema io.k8s.api.core.v1.Volume#vsphereVolume - */ - readonly vsphereVolume?: VsphereVirtualDiskVolumeSource; - -} - -/** - * A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. - * - * @schema io.k8s.api.core.v1.ScopeSelector - */ -export interface ScopeSelector { - /** - * A list of scope selector requirements by scope of the resources. - * - * @schema io.k8s.api.core.v1.ScopeSelector#matchExpressions - */ - readonly matchExpressions?: ScopedResourceSelectorRequirement[]; - -} - -/** - * ServicePort contains information on service's port. - * - * @schema io.k8s.api.core.v1.ServicePort - */ -export interface ServicePort { - /** - * The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. - * - * @schema io.k8s.api.core.v1.ServicePort#name - */ - readonly name?: string; - - /** - * The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport - * - * @default to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport - * @schema io.k8s.api.core.v1.ServicePort#nodePort - */ - readonly nodePort?: number; - - /** - * The port that will be exposed by this service. - * - * @schema io.k8s.api.core.v1.ServicePort#port - */ - readonly port: number; - - /** - * The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. - * - * @default TCP. - * @schema io.k8s.api.core.v1.ServicePort#protocol - */ - readonly protocol?: string; - - /** - * Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service - * - * @schema io.k8s.api.core.v1.ServicePort#targetPort - */ - readonly targetPort?: IntOrString; - -} - -/** - * SessionAffinityConfig represents the configurations of session affinity. - * - * @schema io.k8s.api.core.v1.SessionAffinityConfig - */ -export interface SessionAffinityConfig { - /** - * clientIP contains the configurations of Client IP based session affinity. - * - * @schema io.k8s.api.core.v1.SessionAffinityConfig#clientIP - */ - readonly clientIP?: ClientIpConfig; - -} - -/** - * EndpointConditions represents the current condition of an endpoint. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointConditions - */ -export interface EndpointConditions { - /** - * ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. - * - * @schema io.k8s.api.discovery.v1beta1.EndpointConditions#ready - */ - readonly ready?: boolean; - -} - -/** - * IngressBackend describes all endpoints for a given service and port. - * - * @schema io.k8s.api.networking.v1beta1.IngressBackend - */ -export interface IngressBackend { - /** - * Specifies the name of the referenced service. - * - * @schema io.k8s.api.networking.v1beta1.IngressBackend#serviceName - */ - readonly serviceName: string; - - /** - * Specifies the port of the referenced service. - * - * @schema io.k8s.api.networking.v1beta1.IngressBackend#servicePort - */ - readonly servicePort: IntOrString; - -} - -/** - * IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. - * - * @schema io.k8s.api.networking.v1beta1.IngressRule - */ -export interface IngressRule { - /** - * Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the - IP in the Spec of the parent Ingress. -2. The `:` delimiter is not respected because ports are not allowed. - Currently the port of an Ingress is implicitly :80 for http and - :443 for https. -Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. - * - * @schema io.k8s.api.networking.v1beta1.IngressRule#host - */ - readonly host?: string; - - /** - * @schema io.k8s.api.networking.v1beta1.IngressRule#http - */ - readonly http?: HttpIngressRuleValue; - -} - -/** - * IngressTLS describes the transport layer security associated with an Ingress. - * - * @schema io.k8s.api.networking.v1beta1.IngressTLS - */ -export interface IngressTls { - /** - * Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. - * - * @default the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. - * @schema io.k8s.api.networking.v1beta1.IngressTLS#hosts - */ - readonly hosts?: string[]; - - /** - * SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. - * - * @schema io.k8s.api.networking.v1beta1.IngressTLS#secretName - */ - readonly secretName?: string; - -} - -/** - * NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 - * - * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule - */ -export interface NetworkPolicyEgressRule { - /** - * List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule#ports - */ - readonly ports?: NetworkPolicyPort[]; - - /** - * List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule#to - */ - readonly to?: NetworkPolicyPeer[]; - -} - -/** - * NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule - */ -export interface NetworkPolicyIngressRule { - /** - * List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule#from - */ - readonly from?: NetworkPolicyPeer[]; - - /** - * List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule#ports - */ - readonly ports?: NetworkPolicyPort[]; - -} - -/** - * AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used. - * - * @schema io.k8s.api.policy.v1beta1.AllowedCSIDriver - */ -export interface AllowedCsiDriver { - /** - * Name is the registered name of the CSI driver - * - * @schema io.k8s.api.policy.v1beta1.AllowedCSIDriver#name - */ - readonly name: string; - -} - -/** - * AllowedFlexVolume represents a single Flexvolume that is allowed to be used. - * - * @schema io.k8s.api.policy.v1beta1.AllowedFlexVolume - */ -export interface AllowedFlexVolume { - /** - * driver is the name of the Flexvolume driver. - * - * @schema io.k8s.api.policy.v1beta1.AllowedFlexVolume#driver - */ - readonly driver: string; - -} - -/** - * AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. - * - * @schema io.k8s.api.policy.v1beta1.AllowedHostPath - */ -export interface AllowedHostPath { - /** - * pathPrefix is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. - -Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo` - * - * @schema io.k8s.api.policy.v1beta1.AllowedHostPath#pathPrefix - */ - readonly pathPrefix?: string; - - /** - * when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. - * - * @schema io.k8s.api.policy.v1beta1.AllowedHostPath#readOnly - */ - readonly readOnly?: boolean; - -} - -/** - * FSGroupStrategyOptions defines the strategy type and options used to create the strategy. - * - * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions - */ -export interface FsGroupStrategyOptions { - /** - * ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. - * - * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions#ranges - */ - readonly ranges?: IdRange[]; - - /** - * rule is the strategy that will dictate what FSGroup is used in the SecurityContext. - * - * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions#rule - */ - readonly rule?: string; - -} - -/** - * HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. - * - * @schema io.k8s.api.policy.v1beta1.HostPortRange - */ -export interface HostPortRange { - /** - * max is the end of the range, inclusive. - * - * @schema io.k8s.api.policy.v1beta1.HostPortRange#max - */ - readonly max: number; - - /** - * min is the start of the range, inclusive. - * - * @schema io.k8s.api.policy.v1beta1.HostPortRange#min - */ - readonly min: number; - -} - -/** - * RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy. - * - * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions - */ -export interface RunAsGroupStrategyOptions { - /** - * ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs. - * - * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions#ranges - */ - readonly ranges?: IdRange[]; - - /** - * rule is the strategy that will dictate the allowable RunAsGroup values that may be set. - * - * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions#rule - */ - readonly rule: string; - -} - -/** - * RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. - * - * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions - */ -export interface RunAsUserStrategyOptions { - /** - * ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. - * - * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions#ranges - */ - readonly ranges?: IdRange[]; - - /** - * rule is the strategy that will dictate the allowable RunAsUser values that may be set. - * - * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions#rule - */ - readonly rule: string; - -} - -/** - * RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod. - * - * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions - */ -export interface RuntimeClassStrategyOptions { - /** - * allowedRuntimeClassNames is a whitelist of RuntimeClass names that may be specified on a pod. A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset. - * - * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions#allowedRuntimeClassNames - */ - readonly allowedRuntimeClassNames: string[]; - - /** - * defaultRuntimeClassName is the default RuntimeClassName to set on the pod. The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod. - * - * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions#defaultRuntimeClassName - */ - readonly defaultRuntimeClassName?: string; - -} - -/** - * SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. - * - * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions - */ -export interface SeLinuxStrategyOptions { - /** - * rule is the strategy that will dictate the allowable labels that may be set. - * - * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions#rule - */ - readonly rule: string; - - /** - * seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - * - * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions#seLinuxOptions - */ - readonly seLinuxOptions?: SeLinuxOptions; - -} - -/** - * SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. - * - * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions - */ -export interface SupplementalGroupsStrategyOptions { - /** - * ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs. - * - * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions#ranges - */ - readonly ranges?: IdRange[]; - - /** - * rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. - * - * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions#rule - */ - readonly rule?: string; - -} - -/** - * FlowDistinguisherMethod specifies the method of a flow distinguisher. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowDistinguisherMethod - */ -export interface FlowDistinguisherMethod { - /** - * `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.FlowDistinguisherMethod#type - */ - readonly type: string; - -} - -/** - * PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationReference - */ -export interface PriorityLevelConfigurationReference { - /** - * `name` is the name of the priority level configuration being referenced Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PriorityLevelConfigurationReference#name - */ - readonly name: string; - -} - -/** - * PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects - */ -export interface PolicyRulesWithSubjects { - /** - * `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects#nonResourceRules - */ - readonly nonResourceRules?: NonResourcePolicyRule[]; - - /** - * `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects#resourceRules - */ - readonly resourceRules?: ResourcePolicyRule[]; - - /** - * subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.PolicyRulesWithSubjects#subjects - */ - readonly subjects: Subject[]; - -} - -/** - * LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: - * How are requests for this priority level limited? - * What should be done with requests that exceed the limit? - * - * @schema io.k8s.api.flowcontrol.v1alpha1.LimitedPriorityLevelConfiguration - */ -export interface LimitedPriorityLevelConfiguration { - /** - * `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: - - ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) - -bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.LimitedPriorityLevelConfiguration#assuredConcurrencyShares - */ - readonly assuredConcurrencyShares?: number; - - /** - * `limitResponse` indicates what to do with requests that can not be executed right now - * - * @schema io.k8s.api.flowcontrol.v1alpha1.LimitedPriorityLevelConfiguration#limitResponse - */ - readonly limitResponse?: LimitResponse; - -} - -/** - * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - * - * @schema IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind - */ -export enum IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind { - /** DeleteOptions */ - DELETE_OPTIONS = 'DeleteOptions', -} - -/** - * Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions - */ -export interface Preconditions { - /** - * Specifies the target ResourceVersion - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions#resourceVersion - */ - readonly resourceVersion?: string; - - /** - * Specifies the target UID. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions#uid - */ - readonly uid?: string; - -} - -/** - * @schema io.k8s.apimachinery.pkg.util.intstr.IntOrString - */ -export class IntOrString { - public static fromString(value: string): IntOrString { - return new IntOrString(value); - } - public static fromNumber(value: number): IntOrString { - return new IntOrString(value); - } - private constructor(value: any) { - Object.defineProperty(this, 'resolve', { value: () => value }); - } -} - -/** - * EnvVar represents an environment variable present in a Container. - * - * @schema io.k8s.api.core.v1.EnvVar - */ -export interface EnvVar { - /** - * Name of the environment variable. Must be a C_IDENTIFIER. - * - * @schema io.k8s.api.core.v1.EnvVar#name - */ - readonly name: string; - - /** - * Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". - * - * @default . - * @schema io.k8s.api.core.v1.EnvVar#value - */ - readonly value?: string; - - /** - * Source for the environment variable's value. Cannot be used if value is not empty. - * - * @schema io.k8s.api.core.v1.EnvVar#valueFrom - */ - readonly valueFrom?: EnvVarSource; - -} - -/** - * EnvFromSource represents the source of a set of ConfigMaps - * - * @schema io.k8s.api.core.v1.EnvFromSource - */ -export interface EnvFromSource { - /** - * The ConfigMap to select from - * - * @schema io.k8s.api.core.v1.EnvFromSource#configMapRef - */ - readonly configMapRef?: ConfigMapEnvSource; - - /** - * An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. - * - * @schema io.k8s.api.core.v1.EnvFromSource#prefix - */ - readonly prefix?: string; - - /** - * The Secret to select from - * - * @schema io.k8s.api.core.v1.EnvFromSource#secretRef - */ - readonly secretRef?: SecretEnvSource; - -} - -/** - * VolumeMount describes a mounting of a Volume within a container. - * - * @schema io.k8s.api.core.v1.VolumeMount - */ -export interface VolumeMount { - /** - * Path within the container at which the volume should be mounted. Must not contain ':'. - * - * @schema io.k8s.api.core.v1.VolumeMount#mountPath - */ - readonly mountPath: string; - - /** - * mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. - * - * @schema io.k8s.api.core.v1.VolumeMount#mountPropagation - */ - readonly mountPropagation?: string; - - /** - * This must match the Name of a Volume. - * - * @schema io.k8s.api.core.v1.VolumeMount#name - */ - readonly name: string; - - /** - * Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. - * - * @default false. - * @schema io.k8s.api.core.v1.VolumeMount#readOnly - */ - readonly readOnly?: boolean; - - /** - * Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). - * - * @default volume's root). - * @schema io.k8s.api.core.v1.VolumeMount#subPath - */ - readonly subPath?: string; - - /** - * Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. - * - * @default volume's root). SubPathExpr and SubPath are mutually exclusive. - * @schema io.k8s.api.core.v1.VolumeMount#subPathExpr - */ - readonly subPathExpr?: string; - -} - -/** - * CSINodeDriver holds information about the specification of one CSI driver installed on a node - * - * @schema io.k8s.api.storage.v1.CSINodeDriver - */ -export interface CsiNodeDriver { - /** - * allocatable represents the volume resources of a node that are available for scheduling. This field is beta. - * - * @schema io.k8s.api.storage.v1.CSINodeDriver#allocatable - */ - readonly allocatable?: VolumeNodeResources; - - /** - * This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. - * - * @schema io.k8s.api.storage.v1.CSINodeDriver#name - */ - readonly name: string; - - /** - * nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. - * - * @schema io.k8s.api.storage.v1.CSINodeDriver#nodeID - */ - readonly nodeID: string; - - /** - * topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. - * - * @schema io.k8s.api.storage.v1.CSINodeDriver#topologyKeys - */ - readonly topologyKeys?: string[]; - -} - -/** - * A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future. - * - * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement - */ -export interface TopologySelectorLabelRequirement { - /** - * The label key that the selector applies to. - * - * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement#key - */ - readonly key: string; - - /** - * An array of string values. One value must match the label to be selected. Each entry in Values is ORed. - * - * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement#values - */ - readonly values: string[]; - -} - -/** - * VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSource - */ -export interface VolumeAttachmentSource { - /** - * inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSource#inlineVolumeSpec - */ - readonly inlineVolumeSpec?: PersistentVolumeSpec; - - /** - * Name of the persistent volume to attach. - * - * @schema io.k8s.api.storage.v1.VolumeAttachmentSource#persistentVolumeName - */ - readonly persistentVolumeName?: string; - -} - -/** - * CustomResourceConversion describes how to convert different versions of a CR. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion - */ -export interface CustomResourceConversion { - /** - * strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information - is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion#strategy - */ - readonly strategy: string; - - /** - * webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion#webhook - */ - readonly webhook?: WebhookConversion; - -} - -/** - * CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames - */ -export interface CustomResourceDefinitionNames { - /** - * categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#categories - */ - readonly categories?: string[]; - - /** - * kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#kind - */ - readonly kind: string; - - /** - * listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". - * - * @default kind`List". - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#listKind - */ - readonly listKind?: string; - - /** - * plural is the plural name of the resource to serve. The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#plural - */ - readonly plural: string; - - /** - * shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. It must be all lowercase. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#shortNames - */ - readonly shortNames?: string[]; - - /** - * singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. - * - * @default lowercased `kind`. - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#singular - */ - readonly singular?: string; - -} - -/** - * CustomResourceDefinitionVersion describes a version for CRD. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion - */ -export interface CustomResourceDefinitionVersion { - /** - * additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#additionalPrinterColumns - */ - readonly additionalPrinterColumns?: CustomResourceColumnDefinition[]; - - /** - * name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#name - */ - readonly name: string; - - /** - * schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#schema - */ - readonly schema?: CustomResourceValidation; - - /** - * served is a flag enabling/disabling this version from being served via REST APIs - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#served - */ - readonly served: boolean; - - /** - * storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#storage - */ - readonly storage: boolean; - - /** - * subresources specify what subresources this version of the defined custom resource have. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#subresources - */ - readonly subresources?: CustomResourceSubresources; - -} - -/** - * StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause - */ -export interface StatusCause { - /** - * The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. - -Examples: - "name" - the field "name" on the current resource - "items[0].name" - the field "name" on the first array entry in "items" - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#field - */ - readonly field?: string; - - /** - * A human-readable description of the cause of the error. This field may be presented as-is to a reader. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#message - */ - readonly message?: string; - - /** - * A machine-readable description of the cause of the error. If this value is empty there is no information available. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#reason - */ - readonly reason?: string; - -} - -/** - * ServiceReference holds a reference to Service.legacy.k8s.io - * - * @schema io.k8s.api.admissionregistration.v1.ServiceReference - */ -export interface ServiceReference { - /** - * `name` is the name of the service. Required - * - * @schema io.k8s.api.admissionregistration.v1.ServiceReference#name - */ - readonly name: string; - - /** - * `namespace` is the namespace of the service. Required - * - * @schema io.k8s.api.admissionregistration.v1.ServiceReference#namespace - */ - readonly namespace: string; - - /** - * `path` is an optional URL path which will be sent in any request to this service. - * - * @schema io.k8s.api.admissionregistration.v1.ServiceReference#path - */ - readonly path?: string; - - /** - * If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). - * - * @default 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). - * @schema io.k8s.api.admissionregistration.v1.ServiceReference#port - */ - readonly port?: number; - -} - -/** - * A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement - */ -export interface LabelSelectorRequirement { - /** - * key is the label key that the selector applies to. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#key - */ - readonly key: string; - - /** - * operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#operator - */ - readonly operator: string; - - /** - * values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. - * - * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#values - */ - readonly values?: string[]; - -} - -/** - * Spec to control the desired behavior of daemon set rolling update. - * - * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet - */ -export interface RollingUpdateDaemonSet { - /** - * The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. - * - * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet#maxUnavailable - */ - readonly maxUnavailable?: IntOrString; - -} - -/** - * Spec to control the desired behavior of rolling update. - * - * @schema io.k8s.api.apps.v1.RollingUpdateDeployment - */ -export interface RollingUpdateDeployment { - /** - * The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. - * - * @default 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. - * @schema io.k8s.api.apps.v1.RollingUpdateDeployment#maxSurge - */ - readonly maxSurge?: IntOrString; - - /** - * The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. - * - * @default 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. - * @schema io.k8s.api.apps.v1.RollingUpdateDeployment#maxUnavailable - */ - readonly maxUnavailable?: IntOrString; - -} - -/** - * RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. - * - * @schema io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy - */ -export interface RollingUpdateStatefulSetStrategy { - /** - * Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. - * - * @schema io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy#partition - */ - readonly partition?: number; - -} - -/** - * WebhookThrottleConfig holds the configuration for throttling events - * - * @schema io.k8s.api.auditregistration.v1alpha1.WebhookThrottleConfig - */ -export interface WebhookThrottleConfig { - /** - * ThrottleBurst is the maximum number of events sent at the same moment default 15 QPS - * - * @schema io.k8s.api.auditregistration.v1alpha1.WebhookThrottleConfig#burst - */ - readonly burst?: number; - - /** - * ThrottleQPS maximum number of batches per second default 10 QPS - * - * @schema io.k8s.api.auditregistration.v1alpha1.WebhookThrottleConfig#qps - */ - readonly qps?: number; - -} - -/** - * ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. - * - * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource - */ -export interface ConfigMapNodeConfigSource { - /** - * KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. - * - * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#kubeletConfigKey - */ - readonly kubeletConfigKey: string; - - /** - * Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. - * - * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#name - */ - readonly name: string; - - /** - * Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. - * - * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#namespace - */ - readonly namespace: string; - - /** - * ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. - * - * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#resourceVersion - */ - readonly resourceVersion?: string; - - /** - * UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. - * - * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#uid - */ - readonly uid?: string; - -} - -/** - * SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace - * - * @schema io.k8s.api.core.v1.SecretReference - */ -export interface SecretReference { - /** - * Name is unique within a namespace to reference a secret resource. - * - * @schema io.k8s.api.core.v1.SecretReference#name - */ - readonly name?: string; - - /** - * Namespace defines the space within which the secret name must be unique. - * - * @schema io.k8s.api.core.v1.SecretReference#namespace - */ - readonly namespace?: string; - -} - -/** - * A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. - * - * @schema io.k8s.api.core.v1.NodeSelector - */ -export interface NodeSelector { - /** - * Required. A list of node selector terms. The terms are ORed. - * - * @schema io.k8s.api.core.v1.NodeSelector#nodeSelectorTerms - */ - readonly nodeSelectorTerms: NodeSelectorTerm[]; - -} - -/** - * Node affinity is a group of node affinity scheduling rules. - * - * @schema io.k8s.api.core.v1.NodeAffinity - */ -export interface NodeAffinity { - /** - * The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. - * - * @schema io.k8s.api.core.v1.NodeAffinity#preferredDuringSchedulingIgnoredDuringExecution - */ - readonly preferredDuringSchedulingIgnoredDuringExecution?: PreferredSchedulingTerm[]; - - /** - * If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. - * - * @schema io.k8s.api.core.v1.NodeAffinity#requiredDuringSchedulingIgnoredDuringExecution - */ - readonly requiredDuringSchedulingIgnoredDuringExecution?: NodeSelector; - -} - -/** - * Pod affinity is a group of inter pod affinity scheduling rules. - * - * @schema io.k8s.api.core.v1.PodAffinity - */ -export interface PodAffinity { - /** - * The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. - * - * @schema io.k8s.api.core.v1.PodAffinity#preferredDuringSchedulingIgnoredDuringExecution - */ - readonly preferredDuringSchedulingIgnoredDuringExecution?: WeightedPodAffinityTerm[]; - - /** - * If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. - * - * @schema io.k8s.api.core.v1.PodAffinity#requiredDuringSchedulingIgnoredDuringExecution - */ - readonly requiredDuringSchedulingIgnoredDuringExecution?: PodAffinityTerm[]; - -} - -/** - * Pod anti affinity is a group of inter pod anti affinity scheduling rules. - * - * @schema io.k8s.api.core.v1.PodAntiAffinity - */ -export interface PodAntiAffinity { - /** - * The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. - * - * @schema io.k8s.api.core.v1.PodAntiAffinity#preferredDuringSchedulingIgnoredDuringExecution - */ - readonly preferredDuringSchedulingIgnoredDuringExecution?: WeightedPodAffinityTerm[]; - - /** - * If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. - * - * @schema io.k8s.api.core.v1.PodAntiAffinity#requiredDuringSchedulingIgnoredDuringExecution - */ - readonly requiredDuringSchedulingIgnoredDuringExecution?: PodAffinityTerm[]; - -} - -/** - * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. - * - * @schema io.k8s.api.core.v1.Lifecycle - */ -export interface Lifecycle { - /** - * PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - * - * @schema io.k8s.api.core.v1.Lifecycle#postStart - */ - readonly postStart?: Handler; - - /** - * PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - * - * @schema io.k8s.api.core.v1.Lifecycle#preStop - */ - readonly preStop?: Handler; - -} - -/** - * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. - * - * @schema io.k8s.api.core.v1.Probe - */ -export interface Probe { - /** - * One and only one of the following should be specified. Exec specifies the action to take. - * - * @schema io.k8s.api.core.v1.Probe#exec - */ - readonly exec?: ExecAction; - - /** - * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. - * - * @default 3. Minimum value is 1. - * @schema io.k8s.api.core.v1.Probe#failureThreshold - */ - readonly failureThreshold?: number; - - /** - * HTTPGet specifies the http request to perform. - * - * @schema io.k8s.api.core.v1.Probe#httpGet - */ - readonly httpGet?: HttpGetAction; - - /** - * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * - * @schema io.k8s.api.core.v1.Probe#initialDelaySeconds - */ - readonly initialDelaySeconds?: number; - - /** - * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. - * - * @default 10 seconds. Minimum value is 1. - * @schema io.k8s.api.core.v1.Probe#periodSeconds - */ - readonly periodSeconds?: number; - - /** - * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. - * - * @default 1. Must be 1 for liveness and startup. Minimum value is 1. - * @schema io.k8s.api.core.v1.Probe#successThreshold - */ - readonly successThreshold?: number; - - /** - * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported - * - * @schema io.k8s.api.core.v1.Probe#tcpSocket - */ - readonly tcpSocket?: TcpSocketAction; - - /** - * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * - * @default 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * @schema io.k8s.api.core.v1.Probe#timeoutSeconds - */ - readonly timeoutSeconds?: number; - -} - -/** - * ContainerPort represents a network port in a single container. - * - * @schema io.k8s.api.core.v1.ContainerPort - */ -export interface ContainerPort { - /** - * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. - * - * @schema io.k8s.api.core.v1.ContainerPort#containerPort - */ - readonly containerPort: number; - - /** - * What host IP to bind the external port to. - * - * @schema io.k8s.api.core.v1.ContainerPort#hostIP - */ - readonly hostIP?: string; - - /** - * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. - * - * @schema io.k8s.api.core.v1.ContainerPort#hostPort - */ - readonly hostPort?: number; - - /** - * If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. - * - * @schema io.k8s.api.core.v1.ContainerPort#name - */ - readonly name?: string; - - /** - * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". - * - * @default TCP". - * @schema io.k8s.api.core.v1.ContainerPort#protocol - */ - readonly protocol?: string; - -} - -/** - * SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. - * - * @schema io.k8s.api.core.v1.SecurityContext - */ -export interface SecurityContext { - /** - * AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN - * - * @schema io.k8s.api.core.v1.SecurityContext#allowPrivilegeEscalation - */ - readonly allowPrivilegeEscalation?: boolean; - - /** - * The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. - * - * @default the default set of capabilities granted by the container runtime. - * @schema io.k8s.api.core.v1.SecurityContext#capabilities - */ - readonly capabilities?: Capabilities; - - /** - * Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. - * - * @default false. - * @schema io.k8s.api.core.v1.SecurityContext#privileged - */ - readonly privileged?: boolean; - - /** - * procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. - * - * @schema io.k8s.api.core.v1.SecurityContext#procMount - */ - readonly procMount?: string; - - /** - * Whether this container has a read-only root filesystem. Default is false. - * - * @default false. - * @schema io.k8s.api.core.v1.SecurityContext#readOnlyRootFilesystem - */ - readonly readOnlyRootFilesystem?: boolean; - - /** - * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @schema io.k8s.api.core.v1.SecurityContext#runAsGroup - */ - readonly runAsGroup?: number; - - /** - * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @schema io.k8s.api.core.v1.SecurityContext#runAsNonRoot - */ - readonly runAsNonRoot?: boolean; - - /** - * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @default user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * @schema io.k8s.api.core.v1.SecurityContext#runAsUser - */ - readonly runAsUser?: number; - - /** - * The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @schema io.k8s.api.core.v1.SecurityContext#seLinuxOptions - */ - readonly seLinuxOptions?: SeLinuxOptions; - - /** - * The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - * - * @schema io.k8s.api.core.v1.SecurityContext#windowsOptions - */ - readonly windowsOptions?: WindowsSecurityContextOptions; - -} - -/** - * volumeDevice describes a mapping of a raw block device within a container. - * - * @schema io.k8s.api.core.v1.VolumeDevice - */ -export interface VolumeDevice { - /** - * devicePath is the path inside of the container that the device will be mapped to. - * - * @schema io.k8s.api.core.v1.VolumeDevice#devicePath - */ - readonly devicePath: string; - - /** - * name must match the name of a persistentVolumeClaim in the pod - * - * @schema io.k8s.api.core.v1.VolumeDevice#name - */ - readonly name: string; - -} - -/** - * PodDNSConfigOption defines DNS resolver options of a pod. - * - * @schema io.k8s.api.core.v1.PodDNSConfigOption - */ -export interface PodDnsConfigOption { - /** - * Required. - * - * @schema io.k8s.api.core.v1.PodDNSConfigOption#name - */ - readonly name?: string; - - /** - * @schema io.k8s.api.core.v1.PodDNSConfigOption#value - */ - readonly value?: string; - -} - -/** - * SELinuxOptions are the labels to be applied to the container - * - * @schema io.k8s.api.core.v1.SELinuxOptions - */ -export interface SeLinuxOptions { - /** - * Level is SELinux level label that applies to the container. - * - * @schema io.k8s.api.core.v1.SELinuxOptions#level - */ - readonly level?: string; - - /** - * Role is a SELinux role label that applies to the container. - * - * @schema io.k8s.api.core.v1.SELinuxOptions#role - */ - readonly role?: string; - - /** - * Type is a SELinux type label that applies to the container. - * - * @schema io.k8s.api.core.v1.SELinuxOptions#type - */ - readonly type?: string; - - /** - * User is a SELinux user label that applies to the container. - * - * @schema io.k8s.api.core.v1.SELinuxOptions#user - */ - readonly user?: string; - -} - -/** - * Sysctl defines a kernel parameter to be set - * - * @schema io.k8s.api.core.v1.Sysctl - */ -export interface Sysctl { - /** - * Name of a property to set - * - * @schema io.k8s.api.core.v1.Sysctl#name - */ - readonly name: string; - - /** - * Value of a property to set - * - * @schema io.k8s.api.core.v1.Sysctl#value - */ - readonly value: string; - -} - -/** - * WindowsSecurityContextOptions contain Windows-specific options and credentials. - * - * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions - */ -export interface WindowsSecurityContextOptions { - /** - * GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. - * - * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#gmsaCredentialSpec - */ - readonly gmsaCredentialSpec?: string; - - /** - * GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. - * - * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#gmsaCredentialSpecName - */ - readonly gmsaCredentialSpecName?: string; - - /** - * The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. - * - * @default the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag. - * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#runAsUserName - */ - readonly runAsUserName?: string; - -} - -/** - * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - * - * @schema io.k8s.api.core.v1.AzureFileVolumeSource - */ -export interface AzureFileVolumeSource { - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.AzureFileVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * the name of secret that contains Azure Storage Account Name and Key - * - * @schema io.k8s.api.core.v1.AzureFileVolumeSource#secretName - */ - readonly secretName: string; - - /** - * Share Name - * - * @schema io.k8s.api.core.v1.AzureFileVolumeSource#shareName - */ - readonly shareName: string; - -} - -/** - * Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.CephFSVolumeSource - */ -export interface CephFsVolumeSource { - /** - * Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSVolumeSource#monitors - */ - readonly monitors: string[]; - - /** - * Optional: Used as the mounted root, rather than the full Ceph tree, default is / - * - * @schema io.k8s.api.core.v1.CephFSVolumeSource#path - */ - readonly path?: string; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.CephFSVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSVolumeSource#secretFile - */ - readonly secretFile?: string; - - /** - * Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSVolumeSource#secretRef - */ - readonly secretRef?: LocalObjectReference; - - /** - * Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.CephFSVolumeSource#user - */ - readonly user?: string; - -} - -/** - * Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.CinderVolumeSource - */ -export interface CinderVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @schema io.k8s.api.core.v1.CinderVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * @schema io.k8s.api.core.v1.CinderVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: points to a secret object containing parameters used to connect to OpenStack. - * - * @schema io.k8s.api.core.v1.CinderVolumeSource#secretRef - */ - readonly secretRef?: LocalObjectReference; - - /** - * volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - * - * @schema io.k8s.api.core.v1.CinderVolumeSource#volumeID - */ - readonly volumeID: string; - -} - -/** - * Adapts a ConfigMap into a volume. - -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. - * - * @schema io.k8s.api.core.v1.ConfigMapVolumeSource - */ -export interface ConfigMapVolumeSource { - /** - * Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * - * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#defaultMode - */ - readonly defaultMode?: number; - - /** - * If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. - * - * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#items - */ - readonly items?: KeyToPath[]; - - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#name - */ - readonly name?: string; - - /** - * Specify whether the ConfigMap or its keys must be defined - * - * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#optional - */ - readonly optional?: boolean; - -} - -/** - * Represents a source location of a volume to mount, managed by an external CSI driver - * - * @schema io.k8s.api.core.v1.CSIVolumeSource - */ -export interface CsiVolumeSource { - /** - * Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. - * - * @schema io.k8s.api.core.v1.CSIVolumeSource#driver - */ - readonly driver: string; - - /** - * Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. - * - * @schema io.k8s.api.core.v1.CSIVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. - * - * @schema io.k8s.api.core.v1.CSIVolumeSource#nodePublishSecretRef - */ - readonly nodePublishSecretRef?: LocalObjectReference; - - /** - * Specifies a read-only configuration for the volume. Defaults to false (read/write). - * - * @default false (read/write). - * @schema io.k8s.api.core.v1.CSIVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. - * - * @schema io.k8s.api.core.v1.CSIVolumeSource#volumeAttributes - */ - readonly volumeAttributes?: { [key: string]: string }; - -} - -/** - * DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource - */ -export interface DownwardApiVolumeSource { - /** - * Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * - * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource#defaultMode - */ - readonly defaultMode?: number; - - /** - * Items is a list of downward API volume file - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource#items - */ - readonly items?: DownwardApiVolumeFile[]; - -} - -/** - * Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.EmptyDirVolumeSource - */ -export interface EmptyDirVolumeSource { - /** - * What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - * - * @schema io.k8s.api.core.v1.EmptyDirVolumeSource#medium - */ - readonly medium?: string; - - /** - * Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir - * - * @schema io.k8s.api.core.v1.EmptyDirVolumeSource#sizeLimit - */ - readonly sizeLimit?: Quantity; - -} - -/** - * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. - * - * @schema io.k8s.api.core.v1.FlexVolumeSource - */ -export interface FlexVolumeSource { - /** - * Driver is the name of the driver to use for this volume. - * - * @schema io.k8s.api.core.v1.FlexVolumeSource#driver - */ - readonly driver: string; - - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. - * - * @schema io.k8s.api.core.v1.FlexVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Optional: Extra command options if any. - * - * @schema io.k8s.api.core.v1.FlexVolumeSource#options - */ - readonly options?: { [key: string]: string }; - - /** - * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.FlexVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. - * - * @schema io.k8s.api.core.v1.FlexVolumeSource#secretRef - */ - readonly secretRef?: LocalObjectReference; - -} - -/** - * 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. - -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. - * - * @schema io.k8s.api.core.v1.GitRepoVolumeSource - */ -export interface GitRepoVolumeSource { - /** - * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. - * - * @schema io.k8s.api.core.v1.GitRepoVolumeSource#directory - */ - readonly directory?: string; - - /** - * Repository URL - * - * @schema io.k8s.api.core.v1.GitRepoVolumeSource#repository - */ - readonly repository: string; - - /** - * Commit hash for the specified revision. - * - * @schema io.k8s.api.core.v1.GitRepoVolumeSource#revision - */ - readonly revision?: string; - -} - -/** - * Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. - * - * @schema io.k8s.api.core.v1.GlusterfsVolumeSource - */ -export interface GlusterfsVolumeSource { - /** - * EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#endpoints - */ - readonly endpoints: string; - - /** - * Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#path - */ - readonly path: string; - - /** - * ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * - * @default false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod - * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#readOnly - */ - readonly readOnly?: boolean; - -} - -/** - * Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource - */ -export interface IscsiVolumeSource { - /** - * whether support iSCSI Discovery CHAP authentication - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#chapAuthDiscovery - */ - readonly chapAuthDiscovery?: boolean; - - /** - * whether support iSCSI Session CHAP authentication - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#chapAuthSession - */ - readonly chapAuthSession?: boolean; - - /** - * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#initiatorName - */ - readonly initiatorName?: string; - - /** - * Target iSCSI Qualified Name. - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#iqn - */ - readonly iqn: string; - - /** - * iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). - * - * @default default' (tcp). - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#iscsiInterface - */ - readonly iscsiInterface?: string; - - /** - * iSCSI Target Lun number. - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#lun - */ - readonly lun: number; - - /** - * iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#portals - */ - readonly portals?: string[]; - - /** - * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. - * - * @default false. - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * CHAP Secret for iSCSI target and initiator authentication - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#secretRef - */ - readonly secretRef?: LocalObjectReference; - - /** - * iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - * - * @schema io.k8s.api.core.v1.ISCSIVolumeSource#targetPortal - */ - readonly targetPortal: string; - -} - -/** - * PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource - */ -export interface PersistentVolumeClaimVolumeSource { - /** - * ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource#claimName - */ - readonly claimName: string; - - /** - * Will force the ReadOnly setting in VolumeMounts. Default false. - * - * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource#readOnly - */ - readonly readOnly?: boolean; - -} - -/** - * Represents a projected volume source - * - * @schema io.k8s.api.core.v1.ProjectedVolumeSource - */ -export interface ProjectedVolumeSource { - /** - * Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * - * @schema io.k8s.api.core.v1.ProjectedVolumeSource#defaultMode - */ - readonly defaultMode?: number; - - /** - * list of volume projections - * - * @schema io.k8s.api.core.v1.ProjectedVolumeSource#sources - */ - readonly sources: VolumeProjection[]; - -} - -/** - * Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. - * - * @schema io.k8s.api.core.v1.RBDVolumeSource - */ -export interface RbdVolumeSource { - /** - * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd - * - * @schema io.k8s.api.core.v1.RBDVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.RBDVolumeSource#image - */ - readonly image: string; - - /** - * Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDVolumeSource#keyring - */ - readonly keyring?: string; - - /** - * A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @schema io.k8s.api.core.v1.RBDVolumeSource#monitors - */ - readonly monitors: string[]; - - /** - * The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDVolumeSource#pool - */ - readonly pool?: string; - - /** - * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDVolumeSource#secretRef - */ - readonly secretRef?: LocalObjectReference; - - /** - * The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * - * @default admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - * @schema io.k8s.api.core.v1.RBDVolumeSource#user - */ - readonly user?: string; - -} - -/** - * ScaleIOVolumeSource represents a persistent ScaleIO volume - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource - */ -export interface ScaleIoVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". - * - * @default xfs". - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * The host address of the ScaleIO API Gateway. - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#gateway - */ - readonly gateway: string; - - /** - * The name of the ScaleIO Protection Domain for the configured storage. - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#protectionDomain - */ - readonly protectionDomain?: string; - - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#secretRef - */ - readonly secretRef: LocalObjectReference; - - /** - * Flag to enable/disable SSL communication with Gateway, default false - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#sslEnabled - */ - readonly sslEnabled?: boolean; - - /** - * Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. - * - * @default ThinProvisioned. - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#storageMode - */ - readonly storageMode?: string; - - /** - * The ScaleIO Storage Pool associated with the protection domain. - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#storagePool - */ - readonly storagePool?: string; - - /** - * The name of the storage system as configured in ScaleIO. - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#system - */ - readonly system: string; - - /** - * The name of a volume already created in the ScaleIO system that is associated with this volume source. - * - * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#volumeName - */ - readonly volumeName?: string; - -} - -/** - * Adapts a Secret into a volume. - -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. - * - * @schema io.k8s.api.core.v1.SecretVolumeSource - */ -export interface SecretVolumeSource { - /** - * Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * - * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * @schema io.k8s.api.core.v1.SecretVolumeSource#defaultMode - */ - readonly defaultMode?: number; - - /** - * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. - * - * @schema io.k8s.api.core.v1.SecretVolumeSource#items - */ - readonly items?: KeyToPath[]; - - /** - * Specify whether the Secret or its keys must be defined - * - * @schema io.k8s.api.core.v1.SecretVolumeSource#optional - */ - readonly optional?: boolean; - - /** - * Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - * - * @schema io.k8s.api.core.v1.SecretVolumeSource#secretName - */ - readonly secretName?: string; - -} - -/** - * Represents a StorageOS persistent volume resource. - * - * @schema io.k8s.api.core.v1.StorageOSVolumeSource - */ -export interface StorageOsVolumeSource { - /** - * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - * - * @schema io.k8s.api.core.v1.StorageOSVolumeSource#fsType - */ - readonly fsType?: string; - - /** - * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * - * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - * @schema io.k8s.api.core.v1.StorageOSVolumeSource#readOnly - */ - readonly readOnly?: boolean; - - /** - * SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. - * - * @schema io.k8s.api.core.v1.StorageOSVolumeSource#secretRef - */ - readonly secretRef?: LocalObjectReference; - - /** - * VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. - * - * @schema io.k8s.api.core.v1.StorageOSVolumeSource#volumeName - */ - readonly volumeName?: string; - - /** - * VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. - * - * @schema io.k8s.api.core.v1.StorageOSVolumeSource#volumeNamespace - */ - readonly volumeNamespace?: string; - -} - -/** - * A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. - * - * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement - */ -export interface ScopedResourceSelectorRequirement { - /** - * Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. - * - * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#operator - */ - readonly operator: string; - - /** - * The name of the scope that the selector applies to. - * - * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#scopeName - */ - readonly scopeName: string; - - /** - * An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. - * - * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#values - */ - readonly values?: string[]; - -} - -/** - * ClientIPConfig represents the configurations of Client IP based session affinity. - * - * @schema io.k8s.api.core.v1.ClientIPConfig - */ -export interface ClientIpConfig { - /** - * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). - * - * @schema io.k8s.api.core.v1.ClientIPConfig#timeoutSeconds - */ - readonly timeoutSeconds?: number; - -} - -/** - * HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. - * - * @schema io.k8s.api.networking.v1beta1.HTTPIngressRuleValue - */ -export interface HttpIngressRuleValue { - /** - * A collection of paths that map requests to backends. - * - * @schema io.k8s.api.networking.v1beta1.HTTPIngressRuleValue#paths - */ - readonly paths: HttpIngressPath[]; - -} - -/** - * NetworkPolicyPort describes a port to allow traffic on - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPort - */ -export interface NetworkPolicyPort { - /** - * The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPort#port - */ - readonly port?: IntOrString; - - /** - * The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPort#protocol - */ - readonly protocol?: string; - -} - -/** - * NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPeer - */ -export interface NetworkPolicyPeer { - /** - * IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#ipBlock - */ - readonly ipBlock?: IpBlock; - - /** - * Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. - -If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#namespaceSelector - */ - readonly namespaceSelector?: LabelSelector; - - /** - * This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. - -If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. - * - * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#podSelector - */ - readonly podSelector?: LabelSelector; - -} - -/** - * IDRange provides a min/max of an allowed range of IDs. - * - * @schema io.k8s.api.policy.v1beta1.IDRange - */ -export interface IdRange { - /** - * max is the end of the range, inclusive. - * - * @schema io.k8s.api.policy.v1beta1.IDRange#max - */ - readonly max: number; - - /** - * min is the start of the range, inclusive. - * - * @schema io.k8s.api.policy.v1beta1.IDRange#min - */ - readonly min: number; - -} - -/** - * NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.NonResourcePolicyRule - */ -export interface NonResourcePolicyRule { - /** - * `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - - "/healthz" is legal - - "/hea*" is illegal - - "/hea" is legal but matches nothing - - "/hea/*" also matches nothing - - "/healthz/*" matches all per-component health checks. -"*" matches all non-resource urls. if it is present, it must be the only entry. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.NonResourcePolicyRule#nonResourceURLs - */ - readonly nonResourceURLs: string[]; - - /** - * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.NonResourcePolicyRule#verbs - */ - readonly verbs: string[]; - -} - -/** - * ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule - */ -export interface ResourcePolicyRule { - /** - * `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#apiGroups - */ - readonly apiGroups: string[]; - - /** - * `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#clusterScope - */ - readonly clusterScope?: boolean; - - /** - * `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#namespaces - */ - readonly namespaces?: string[]; - - /** - * `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#resources - */ - readonly resources: string[]; - - /** - * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.ResourcePolicyRule#verbs - */ - readonly verbs: string[]; - -} - -/** - * LimitResponse defines how to handle requests that can not be executed right now. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.LimitResponse - */ -export interface LimitResponse { - /** - * `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.LimitResponse#queuing - */ - readonly queuing?: QueuingConfiguration; - - /** - * `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.LimitResponse#type - */ - readonly type: string; - -} - -/** - * EnvVarSource represents a source for the value of an EnvVar. - * - * @schema io.k8s.api.core.v1.EnvVarSource - */ -export interface EnvVarSource { - /** - * Selects a key of a ConfigMap. - * - * @schema io.k8s.api.core.v1.EnvVarSource#configMapKeyRef - */ - readonly configMapKeyRef?: ConfigMapKeySelector; - - /** - * Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - * - * @schema io.k8s.api.core.v1.EnvVarSource#fieldRef - */ - readonly fieldRef?: ObjectFieldSelector; - - /** - * Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. - * - * @schema io.k8s.api.core.v1.EnvVarSource#resourceFieldRef - */ - readonly resourceFieldRef?: ResourceFieldSelector; - - /** - * Selects a key of a secret in the pod's namespace - * - * @schema io.k8s.api.core.v1.EnvVarSource#secretKeyRef - */ - readonly secretKeyRef?: SecretKeySelector; - -} - -/** - * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. - -The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. - * - * @schema io.k8s.api.core.v1.ConfigMapEnvSource - */ -export interface ConfigMapEnvSource { - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.ConfigMapEnvSource#name - */ - readonly name?: string; - - /** - * Specify whether the ConfigMap must be defined - * - * @schema io.k8s.api.core.v1.ConfigMapEnvSource#optional - */ - readonly optional?: boolean; - -} - -/** - * SecretEnvSource selects a Secret to populate the environment variables with. - -The contents of the target Secret's Data field will represent the key-value pairs as environment variables. - * - * @schema io.k8s.api.core.v1.SecretEnvSource - */ -export interface SecretEnvSource { - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.SecretEnvSource#name - */ - readonly name?: string; - - /** - * Specify whether the Secret must be defined - * - * @schema io.k8s.api.core.v1.SecretEnvSource#optional - */ - readonly optional?: boolean; - -} - -/** - * VolumeNodeResources is a set of resource limits for scheduling of volumes. - * - * @schema io.k8s.api.storage.v1.VolumeNodeResources - */ -export interface VolumeNodeResources { - /** - * Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded. - * - * @schema io.k8s.api.storage.v1.VolumeNodeResources#count - */ - readonly count?: number; - -} - -/** - * WebhookConversion describes how to call a conversion webhook - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion - */ -export interface WebhookConversion { - /** - * clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion#clientConfig - */ - readonly clientConfig?: WebhookClientConfig; - - /** - * conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion#conversionReviewVersions - */ - readonly conversionReviewVersions: string[]; - -} - -/** - * CustomResourceColumnDefinition specifies a column for server side printing. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition - */ -export interface CustomResourceColumnDefinition { - /** - * description is a human readable description of this column. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#description - */ - readonly description?: string; - - /** - * format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#format - */ - readonly format?: string; - - /** - * jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#jsonPath - */ - readonly jsonPath: string; - - /** - * name is a human readable name for the column. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#name - */ - readonly name: string; - - /** - * priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#priority - */ - readonly priority?: number; - - /** - * type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#type - */ - readonly type: string; - -} - -/** - * CustomResourceValidation is a list of validation methods for CustomResources. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation - */ -export interface CustomResourceValidation { - /** - * openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation#openAPIV3Schema - */ - readonly openAPIV3Schema?: JsonSchemaProps; - -} - -/** - * CustomResourceSubresources defines the status and scale subresources for CustomResources. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources - */ -export interface CustomResourceSubresources { - /** - * scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources#scale - */ - readonly scale?: CustomResourceSubresourceScale; - - /** - * status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources#status - */ - readonly status?: any; - -} - -/** - * A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. - * - * @schema io.k8s.api.core.v1.NodeSelectorTerm - */ -export interface NodeSelectorTerm { - /** - * A list of node selector requirements by node's labels. - * - * @schema io.k8s.api.core.v1.NodeSelectorTerm#matchExpressions - */ - readonly matchExpressions?: NodeSelectorRequirement[]; - - /** - * A list of node selector requirements by node's fields. - * - * @schema io.k8s.api.core.v1.NodeSelectorTerm#matchFields - */ - readonly matchFields?: NodeSelectorRequirement[]; - -} - -/** - * An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). - * - * @schema io.k8s.api.core.v1.PreferredSchedulingTerm - */ -export interface PreferredSchedulingTerm { - /** - * A node selector term, associated with the corresponding weight. - * - * @schema io.k8s.api.core.v1.PreferredSchedulingTerm#preference - */ - readonly preference: NodeSelectorTerm; - - /** - * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. - * - * @schema io.k8s.api.core.v1.PreferredSchedulingTerm#weight - */ - readonly weight: number; - -} - -/** - * The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - * - * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm - */ -export interface WeightedPodAffinityTerm { - /** - * Required. A pod affinity term, associated with the corresponding weight. - * - * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm#podAffinityTerm - */ - readonly podAffinityTerm: PodAffinityTerm; - - /** - * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. - * - * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm#weight - */ - readonly weight: number; - -} - -/** - * Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running - * - * @schema io.k8s.api.core.v1.PodAffinityTerm - */ -export interface PodAffinityTerm { - /** - * A label query over a set of resources, in this case pods. - * - * @schema io.k8s.api.core.v1.PodAffinityTerm#labelSelector - */ - readonly labelSelector?: LabelSelector; - - /** - * namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" - * - * @schema io.k8s.api.core.v1.PodAffinityTerm#namespaces - */ - readonly namespaces?: string[]; - - /** - * This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. - * - * @schema io.k8s.api.core.v1.PodAffinityTerm#topologyKey - */ - readonly topologyKey: string; - -} - -/** - * Handler defines a specific action that should be taken - * - * @schema io.k8s.api.core.v1.Handler - */ -export interface Handler { - /** - * One and only one of the following should be specified. Exec specifies the action to take. - * - * @schema io.k8s.api.core.v1.Handler#exec - */ - readonly exec?: ExecAction; - - /** - * HTTPGet specifies the http request to perform. - * - * @schema io.k8s.api.core.v1.Handler#httpGet - */ - readonly httpGet?: HttpGetAction; - - /** - * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported - * - * @schema io.k8s.api.core.v1.Handler#tcpSocket - */ - readonly tcpSocket?: TcpSocketAction; - -} - -/** - * ExecAction describes a "run in container" action. - * - * @schema io.k8s.api.core.v1.ExecAction - */ -export interface ExecAction { - /** - * Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - * - * @schema io.k8s.api.core.v1.ExecAction#command - */ - readonly command?: string[]; - -} - -/** - * HTTPGetAction describes an action based on HTTP Get requests. - * - * @schema io.k8s.api.core.v1.HTTPGetAction - */ -export interface HttpGetAction { - /** - * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. - * - * @schema io.k8s.api.core.v1.HTTPGetAction#host - */ - readonly host?: string; - - /** - * Custom headers to set in the request. HTTP allows repeated headers. - * - * @schema io.k8s.api.core.v1.HTTPGetAction#httpHeaders - */ - readonly httpHeaders?: HttpHeader[]; - - /** - * Path to access on the HTTP server. - * - * @schema io.k8s.api.core.v1.HTTPGetAction#path - */ - readonly path?: string; - - /** - * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - * - * @schema io.k8s.api.core.v1.HTTPGetAction#port - */ - readonly port: IntOrString; - - /** - * Scheme to use for connecting to the host. Defaults to HTTP. - * - * @default HTTP. - * @schema io.k8s.api.core.v1.HTTPGetAction#scheme - */ - readonly scheme?: string; - -} - -/** - * TCPSocketAction describes an action based on opening a socket - * - * @schema io.k8s.api.core.v1.TCPSocketAction - */ -export interface TcpSocketAction { - /** - * Optional: Host name to connect to, defaults to the pod IP. - * - * @schema io.k8s.api.core.v1.TCPSocketAction#host - */ - readonly host?: string; - - /** - * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - * - * @schema io.k8s.api.core.v1.TCPSocketAction#port - */ - readonly port: IntOrString; - -} - -/** - * Adds and removes POSIX capabilities from running containers. - * - * @schema io.k8s.api.core.v1.Capabilities - */ -export interface Capabilities { - /** - * Added capabilities - * - * @schema io.k8s.api.core.v1.Capabilities#add - */ - readonly add?: string[]; - - /** - * Removed capabilities - * - * @schema io.k8s.api.core.v1.Capabilities#drop - */ - readonly drop?: string[]; - -} - -/** - * Maps a string key to a path within a volume. - * - * @schema io.k8s.api.core.v1.KeyToPath - */ -export interface KeyToPath { - /** - * The key to project. - * - * @schema io.k8s.api.core.v1.KeyToPath#key - */ - readonly key: string; - - /** - * Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * - * @schema io.k8s.api.core.v1.KeyToPath#mode - */ - readonly mode?: number; - - /** - * The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. - * - * @schema io.k8s.api.core.v1.KeyToPath#path - */ - readonly path: string; - -} - -/** - * DownwardAPIVolumeFile represents information to create the file containing the pod field - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile - */ -export interface DownwardApiVolumeFile { - /** - * Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#fieldRef - */ - readonly fieldRef?: ObjectFieldSelector; - - /** - * Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#mode - */ - readonly mode?: number; - - /** - * Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#path - */ - readonly path: string; - - /** - * Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - * - * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#resourceFieldRef - */ - readonly resourceFieldRef?: ResourceFieldSelector; - -} - -/** - * Projection that may be projected along with other supported volume types - * - * @schema io.k8s.api.core.v1.VolumeProjection - */ -export interface VolumeProjection { - /** - * information about the configMap data to project - * - * @schema io.k8s.api.core.v1.VolumeProjection#configMap - */ - readonly configMap?: ConfigMapProjection; - - /** - * information about the downwardAPI data to project - * - * @schema io.k8s.api.core.v1.VolumeProjection#downwardAPI - */ - readonly downwardAPI?: DownwardApiProjection; - - /** - * information about the secret data to project - * - * @schema io.k8s.api.core.v1.VolumeProjection#secret - */ - readonly secret?: SecretProjection; - - /** - * information about the serviceAccountToken data to project - * - * @schema io.k8s.api.core.v1.VolumeProjection#serviceAccountToken - */ - readonly serviceAccountToken?: ServiceAccountTokenProjection; - -} - -/** - * HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend. - * - * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath - */ -export interface HttpIngressPath { - /** - * Backend defines the referenced service endpoint to which the traffic will be forwarded to. - * - * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#backend - */ - readonly backend: IngressBackend; - - /** - * Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend. - * - * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#path - */ - readonly path?: string; - -} - -/** - * IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. - * - * @schema io.k8s.api.networking.v1.IPBlock - */ -export interface IpBlock { - /** - * CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" - * - * @schema io.k8s.api.networking.v1.IPBlock#cidr - */ - readonly cidr: string; - - /** - * Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range - * - * @schema io.k8s.api.networking.v1.IPBlock#except - */ - readonly except?: string[]; - -} - -/** - * QueuingConfiguration holds the configuration parameters for queuing - * - * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration - */ -export interface QueuingConfiguration { - /** - * `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration#handSize - */ - readonly handSize?: number; - - /** - * `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration#queueLengthLimit - */ - readonly queueLengthLimit?: number; - - /** - * `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. - * - * @schema io.k8s.api.flowcontrol.v1alpha1.QueuingConfiguration#queues - */ - readonly queues?: number; - -} - -/** - * Selects a key from a ConfigMap. - * - * @schema io.k8s.api.core.v1.ConfigMapKeySelector - */ -export interface ConfigMapKeySelector { - /** - * The key to select. - * - * @schema io.k8s.api.core.v1.ConfigMapKeySelector#key - */ - readonly key: string; - - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.ConfigMapKeySelector#name - */ - readonly name?: string; - - /** - * Specify whether the ConfigMap or its key must be defined - * - * @schema io.k8s.api.core.v1.ConfigMapKeySelector#optional - */ - readonly optional?: boolean; - -} - -/** - * ObjectFieldSelector selects an APIVersioned field of an object. - * - * @schema io.k8s.api.core.v1.ObjectFieldSelector - */ -export interface ObjectFieldSelector { - /** - * Version of the schema the FieldPath is written in terms of, defaults to "v1". - * - * @schema io.k8s.api.core.v1.ObjectFieldSelector#apiVersion - */ - readonly apiVersion?: string; - - /** - * Path of the field to select in the specified API version. - * - * @schema io.k8s.api.core.v1.ObjectFieldSelector#fieldPath - */ - readonly fieldPath: string; - -} - -/** - * ResourceFieldSelector represents container resources (cpu, memory) and their output format - * - * @schema io.k8s.api.core.v1.ResourceFieldSelector - */ -export interface ResourceFieldSelector { - /** - * Container name: required for volumes, optional for env vars - * - * @schema io.k8s.api.core.v1.ResourceFieldSelector#containerName - */ - readonly containerName?: string; - - /** - * Specifies the output format of the exposed resources, defaults to "1" - * - * @schema io.k8s.api.core.v1.ResourceFieldSelector#divisor - */ - readonly divisor?: Quantity; - - /** - * Required: resource to select - * - * @schema io.k8s.api.core.v1.ResourceFieldSelector#resource - */ - readonly resource: string; - -} - -/** - * SecretKeySelector selects a key of a Secret. - * - * @schema io.k8s.api.core.v1.SecretKeySelector - */ -export interface SecretKeySelector { - /** - * The key of the secret to select from. Must be a valid secret key. - * - * @schema io.k8s.api.core.v1.SecretKeySelector#key - */ - readonly key: string; - - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.SecretKeySelector#name - */ - readonly name?: string; - - /** - * Specify whether the Secret or its key must be defined - * - * @schema io.k8s.api.core.v1.SecretKeySelector#optional - */ - readonly optional?: boolean; - -} - -/** - * JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps - */ -export interface JsonSchemaProps { - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#$ref - */ - readonly ref?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#$schema - */ - readonly schema?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#additionalItems - */ - readonly additionalItems?: any; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#additionalProperties - */ - readonly additionalProperties?: any; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#allOf - */ - readonly allOf?: JsonSchemaProps[]; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#anyOf - */ - readonly anyOf?: JsonSchemaProps[]; - - /** - * default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#default - */ - readonly default?: any; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#definitions - */ - readonly definitions?: { [key: string]: JsonSchemaProps }; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#dependencies - */ - readonly dependencies?: { [key: string]: any }; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#description - */ - readonly description?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#enum - */ - readonly enum?: any[]; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#example - */ - readonly example?: any; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#exclusiveMaximum - */ - readonly exclusiveMaximum?: boolean; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#exclusiveMinimum - */ - readonly exclusiveMinimum?: boolean; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#externalDocs - */ - readonly externalDocs?: ExternalDocumentation; - - /** - * format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: - -- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#format - */ - readonly format?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#id - */ - readonly id?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#items - */ - readonly items?: any; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxItems - */ - readonly maxItems?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxLength - */ - readonly maxLength?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxProperties - */ - readonly maxProperties?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maximum - */ - readonly maximum?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minItems - */ - readonly minItems?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minLength - */ - readonly minLength?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minProperties - */ - readonly minProperties?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minimum - */ - readonly minimum?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#multipleOf - */ - readonly multipleOf?: number; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#not - */ - readonly not?: JsonSchemaProps; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#nullable - */ - readonly nullable?: boolean; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#oneOf - */ - readonly oneOf?: JsonSchemaProps[]; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#pattern - */ - readonly pattern?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#patternProperties - */ - readonly patternProperties?: { [key: string]: JsonSchemaProps }; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#properties - */ - readonly properties?: { [key: string]: JsonSchemaProps }; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#required - */ - readonly required?: string[]; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#title - */ - readonly title?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#type - */ - readonly type?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#uniqueItems - */ - readonly uniqueItems?: boolean; - -} - -/** - * CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale - */ -export interface CustomResourceSubresourceScale { - /** - * labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#labelSelectorPath - */ - readonly labelSelectorPath?: string; - - /** - * specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#specReplicasPath - */ - readonly specReplicasPath: string; - - /** - * statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#statusReplicasPath - */ - readonly statusReplicasPath: string; - -} - -/** - * A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. - * - * @schema io.k8s.api.core.v1.NodeSelectorRequirement - */ -export interface NodeSelectorRequirement { - /** - * The label key that the selector applies to. - * - * @schema io.k8s.api.core.v1.NodeSelectorRequirement#key - */ - readonly key: string; - - /** - * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. - * - * @schema io.k8s.api.core.v1.NodeSelectorRequirement#operator - */ - readonly operator: string; - - /** - * An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. - * - * @schema io.k8s.api.core.v1.NodeSelectorRequirement#values - */ - readonly values?: string[]; - -} - -/** - * HTTPHeader describes a custom header to be used in HTTP probes - * - * @schema io.k8s.api.core.v1.HTTPHeader - */ -export interface HttpHeader { - /** - * The header field name - * - * @schema io.k8s.api.core.v1.HTTPHeader#name - */ - readonly name: string; - - /** - * The header field value - * - * @schema io.k8s.api.core.v1.HTTPHeader#value - */ - readonly value: string; - -} - -/** - * Adapts a ConfigMap into a projected volume. - -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. - * - * @schema io.k8s.api.core.v1.ConfigMapProjection - */ -export interface ConfigMapProjection { - /** - * If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. - * - * @schema io.k8s.api.core.v1.ConfigMapProjection#items - */ - readonly items?: KeyToPath[]; - - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.ConfigMapProjection#name - */ - readonly name?: string; - - /** - * Specify whether the ConfigMap or its keys must be defined - * - * @schema io.k8s.api.core.v1.ConfigMapProjection#optional - */ - readonly optional?: boolean; - -} - -/** - * Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. - * - * @schema io.k8s.api.core.v1.DownwardAPIProjection - */ -export interface DownwardApiProjection { - /** - * Items is a list of DownwardAPIVolume file - * - * @schema io.k8s.api.core.v1.DownwardAPIProjection#items - */ - readonly items?: DownwardApiVolumeFile[]; - -} - -/** - * Adapts a secret into a projected volume. - -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. - * - * @schema io.k8s.api.core.v1.SecretProjection - */ -export interface SecretProjection { - /** - * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. - * - * @schema io.k8s.api.core.v1.SecretProjection#items - */ - readonly items?: KeyToPath[]; - - /** - * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - * - * @schema io.k8s.api.core.v1.SecretProjection#name - */ - readonly name?: string; - - /** - * Specify whether the Secret or its key must be defined - * - * @schema io.k8s.api.core.v1.SecretProjection#optional - */ - readonly optional?: boolean; - -} - -/** - * ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). - * - * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection - */ -export interface ServiceAccountTokenProjection { - /** - * Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. - * - * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#audience - */ - readonly audience?: string; - - /** - * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. - * - * @default 1 hour and must be at least 10 minutes. - * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#expirationSeconds - */ - readonly expirationSeconds?: number; - - /** - * Path is the path relative to the mount point of the file to project the token into. - * - * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#path - */ - readonly path: string; - -} - -/** - * ExternalDocumentation allows referencing an external resource for extended documentation. - * - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation - */ -export interface ExternalDocumentation { - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation#description - */ - readonly description?: string; - - /** - * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation#url - */ - readonly url?: string; - -} - diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts index 497905a712fb3..61860df4b94c5 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.ts @@ -4,10 +4,10 @@ import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import { App, CfnOutput, Duration, Token, Fn } from '@aws-cdk/core'; import * as cdk8s from 'cdk8s'; +import * as kplus from 'cdk8s-plus'; import * as constructs from 'constructs'; import * as eks from '../lib'; import * as hello from './hello-k8s'; -import * as k8s from './imports/k8s-v1_17_0'; import { Pinger } from './pinger/pinger'; import { TestStack } from './util'; @@ -113,7 +113,7 @@ class EksClusterStack extends TestStack { constructor(scope: constructs.Construct, ns: string, cluster: eks.ICluster) { super(scope, ns); - new k8s.ConfigMap(this, 'config-map', { + new kplus.ConfigMap(this, 'config-map', { data: { clusterName: cluster.clusterName, }, From 9240ea605d0a4cacc40657259f667eca1d96ecaa Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 5 Oct 2020 15:17:36 +0300 Subject: [PATCH 29/36] imports order --- packages/@aws-cdk/aws-eks/lib/cluster.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/@aws-cdk/aws-eks/lib/cluster.ts b/packages/@aws-cdk/aws-eks/lib/cluster.ts index b3d57bd0c84b2..ae9e1dbdc6dc1 100644 --- a/packages/@aws-cdk/aws-eks/lib/cluster.ts +++ b/packages/@aws-cdk/aws-eks/lib/cluster.ts @@ -6,8 +6,8 @@ import * as iam from '@aws-cdk/aws-iam'; import * as kms from '@aws-cdk/aws-kms'; import * as lambda from '@aws-cdk/aws-lambda'; import * as ssm from '@aws-cdk/aws-ssm'; -import * as cdk8s from 'cdk8s'; import { Annotations, CfnOutput, CfnResource, IResource, Resource, Stack, Tags, Token, Duration } from '@aws-cdk/core'; +import * as cdk8s from 'cdk8s'; import { Construct, Node } from 'constructs'; import * as YAML from 'yaml'; import { AwsAuth } from './aws-auth'; From 1c897a1e4f6cf9e41ba61283ad0fd09c4c314ba0 Mon Sep 17 00:00:00 2001 From: epolon Date: Mon, 5 Oct 2020 17:30:46 +0300 Subject: [PATCH 30/36] integ --- packages/@aws-cdk/aws-eks/README.md | 63 +++++++++++----- .../test/integ.eks-cluster.expected.json | 72 +++++++++---------- 2 files changed, 82 insertions(+), 53 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 627e42c8901d1..c46f2a3c50e65 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -814,7 +814,7 @@ chart2.node.addDependency(chart1); #### CDK8s Charts -[CDK8s](https://cdk8s.io/) is an open-source library that enables Kubernetes manifest authoring using familiar programming languages. It is founded on the same technologies as the AWS CDK such as [`constructs`](https://github.com/aws/constructs) and [`jsii`](https://github.com/aws/jsii). +[CDK8s](https://cdk8s.io/) is an open-source library that enables Kubernetes manifest authoring using familiar programming languages. It is founded on the same technologies as the AWS CDK, such as [`constructs`](https://github.com/aws/constructs) and [`jsii`](https://github.com/aws/jsii). > To learn more about cdk8s, visit the [Getting Started](https://github.com/awslabs/cdk8s/tree/master/docs/getting-started) tutorials. @@ -827,20 +827,18 @@ To get started, add the following dependencies to your `package.json` file: ```json dependencies: { - "cdk8s": "0.29.0", - "cdk8s-plus": "0.29.0", + "cdk8s": "0.30.0", + "cdk8s-plus": "0.30.0", "constructs": "3.0.4", } ``` -> Note that the version of `cdk8s` must be `>=0.29.0`. +> Note that the version of `cdk8s` must be `>=0.30.0`. -We recommend seperate the `cdk8s` charts to a different file and extend the `cdk8s.Chart` class. -Notice that `cdk8s` uses the `Construct` class from the [`constructs`](https://github.com/aws/constructs) module, not from `@aws-cdk/core`. +We recommend to seperate the `cdk8s` charts to a different file and extend the `cdk8s.Chart` class. +You can use `aws-cdk` construct attributes and properties inside your `cdk8s` construct freely. -You can freely pass cdk constructs to it and use any of its properties and attributes. - -In this example we create a chart that accepts an `s3.IBucket` and passes its name to a kubernetes pod as an environment variable. +In this example we create a chart that accepts an `s3.Bucket` and passes its name to a kubernetes pod as an environment variable. ```ts import * as s3 from '@aws-cdk/aws-s3'; @@ -850,7 +848,7 @@ import * as kplus from 'cdk8s-plus'; export interface MyChartProps { - readonly bucket: s3.IBucket; + readonly bucket: s3.Bucket; } export class MyChart extends cdk8s.Chart { @@ -877,28 +875,59 @@ export class MyChart extends cdk8s.Chart { Then, in your cdk app: ```ts -import * as eks from '@aws-cdk/aws-eks'; import * as s3 from '@aws-cdk/aws-s3'; import * as cdk8s from 'cdk8s'; import { MyChart } from './my-chart' -const cluster = new eks.Cluster(this, 'HelloCDK8s', { - version: eks.KubernetesVersion.V1_17, -}); - // some bucket.. const bucket = new s3.Bucket(this, 'Bucket'); -// create a cdk8s chart. +// create a cdk8s chart and use `cdk8s.App` as the scope. const myChart = new MyChart(new cdk8s.App(), 'MyChart', { bucket }); // add the cdk8s chart to the cluster cluster.addCdk8sChart('my-chart', myChart); ``` -Note that at this moment, you cannot use AWS CDK constructs as scopes for CDK8s constructs. +Note that at this moment, you cannot use AWS CDK constructs as scopes for CDK8s constructs, or vise versa. This is why we use `new cdk8s.App()` as the scope of the chart itself. +##### Custom CDK8s Constructs + +You can also compose a few stock `cdk8s+` constructs into your own custom construct. However, since mixing scopes between `aws-cdk` and `cdk8s` is currently not supported, the `Construct` class +you'll need to use is the one from the [`constructs`](https://github.com/aws/constructs) module, and not from `@aws-cdk/core` like you normally would. +This is why we used `new cdk8s.App()` as the scope of the chart above. + +```ts +import * as constructs from 'constructs'; +import * as cdk8s from 'cdk8s'; +import * as kplus from 'cdk8s-plus'; + +export interface LoadBalancedWebService { + readonly port: number; + readonly image: string; + readonly replicas: number; +} + +export class LoadBalancedWebService extends constructs.Construct { + constructor(scope: constructs.Construct, id: string, props: LoadBalancedWebService) { + super(scope, id); + + const deployment = new kplus.Deployment(chart, 'Deployment', { + spec: { + replicas: props.replicas, + podSpecTemplate: { + containers: [ new kplus.Container({ image: props.image }) ] + } + }, + }); + + deployment.expose({port: props.port, serviceType: kplus.ServiceType.LOAD_BALANCER}) + + } +} +``` + ##### Caveat `cdk8s+` is vended with a static version of the kubernetes API spec. See ... diff --git a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json index b4840d88c73c4..6f5bb70ec88c7 100644 --- a/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json +++ b/packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json @@ -3433,7 +3433,7 @@ { "Ref": "Cluster9EE0221C" }, - "\"},\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"chart-config-map-95fdf26d\"}}]" + "\"},\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"chart-config-map-configmap-cccf3117\"}}]" ] ] }, @@ -3747,7 +3747,7 @@ }, "/", { - "Ref": "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3BucketB88F8513" + "Ref": "AssetParametersa69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0cS3Bucket1CB7A187" }, "/", { @@ -3757,7 +3757,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3VersionKey26664BF8" + "Ref": "AssetParametersa69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0cS3VersionKey7C13F243" } ] } @@ -3770,7 +3770,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3VersionKey26664BF8" + "Ref": "AssetParametersa69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0cS3VersionKey7C13F243" } ] } @@ -3792,11 +3792,11 @@ "referencetoawscdkeksclustertestAssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3VersionKey2B8F3ED3Ref": { "Ref": "AssetParameters87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dbaS3VersionKeyDE8A2F1F" }, - "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3BucketB9F274F7Ref": { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0" + "referencetoawscdkeksclustertestAssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3Bucket0815E7B5Ref": { + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3BucketDC4B98B1" }, - "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey6A81B439Ref": { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" + "referencetoawscdkeksclustertestAssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKey657736ADRef": { + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKeyA495226F" } } } @@ -3814,7 +3814,7 @@ }, "/", { - "Ref": "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3Bucket670DC328" + "Ref": "AssetParameters8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64S3BucketAA0CCE0D" }, "/", { @@ -3824,7 +3824,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3VersionKeyD4E56B7F" + "Ref": "AssetParameters8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64S3VersionKey3012C8DD" } ] } @@ -3837,7 +3837,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3VersionKeyD4E56B7F" + "Ref": "AssetParameters8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64S3VersionKey3012C8DD" } ] } @@ -3880,11 +3880,11 @@ "ClusterSecurityGroupId" ] }, - "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3BucketB9F274F7Ref": { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0" + "referencetoawscdkeksclustertestAssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3Bucket0815E7B5Ref": { + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3BucketDC4B98B1" }, - "referencetoawscdkeksclustertestAssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey6A81B439Ref": { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" + "referencetoawscdkeksclustertestAssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKey657736ADRef": { + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKeyA495226F" } } } @@ -4308,7 +4308,7 @@ "Properties": { "Code": { "S3Bucket": { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0" + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3BucketDC4B98B1" }, "S3Key": { "Fn::Join": [ @@ -4321,7 +4321,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKeyA495226F" } ] } @@ -4334,7 +4334,7 @@ "Fn::Split": [ "||", { - "Ref": "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A" + "Ref": "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKeyA495226F" } ] } @@ -4507,17 +4507,17 @@ "Type": "String", "Description": "Artifact hash for asset \"87b1e2c41f84590d14f7ab8cb0f338c51d6fa3efe78943867af07fa959593dba\"" }, - "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3Bucket8132A6E0": { + "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3BucketDC4B98B1": { "Type": "String", - "Description": "S3 bucket for asset \"5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0c\"" + "Description": "S3 bucket for asset \"daeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1\"" }, - "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cS3VersionKey722E831A": { + "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1S3VersionKeyA495226F": { "Type": "String", - "Description": "S3 key for asset version \"5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0c\"" + "Description": "S3 key for asset version \"daeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1\"" }, - "AssetParameters5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0cArtifactHash67988836": { + "AssetParametersdaeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1ArtifactHashA521A16F": { "Type": "String", - "Description": "Artifact hash for asset \"5db52e19f1f79cac27e817fa59d0b1f73d524301b679e2e7354122e474fcba0c\"" + "Description": "Artifact hash for asset \"daeb79e3cee39c9b902dc0d5c780223e227ed573ea60976252947adab5fb2be1\"" }, "AssetParametersb7d8a9750f8bfded8ac76be100e3bee1c3d4824df006766110d023f42952f5c2S3Bucket9ABBD5A2": { "Type": "String", @@ -4567,29 +4567,29 @@ "Type": "String", "Description": "Artifact hash for asset \"2acc31b34c05692ab3ea9831a27e5f241cffb21857e633d8256b8f0ebf5f3f43\"" }, - "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3BucketB88F8513": { + "AssetParametersa69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0cS3Bucket1CB7A187": { "Type": "String", - "Description": "S3 bucket for asset \"4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128a\"" + "Description": "S3 bucket for asset \"a69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0c\"" }, - "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aS3VersionKey26664BF8": { + "AssetParametersa69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0cS3VersionKey7C13F243": { "Type": "String", - "Description": "S3 key for asset version \"4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128a\"" + "Description": "S3 key for asset version \"a69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0c\"" }, - "AssetParameters4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128aArtifactHash19301AD9": { + "AssetParametersa69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0cArtifactHashBADE945D": { "Type": "String", - "Description": "Artifact hash for asset \"4af008b5dd4269dc66b62c4466afb6a7fd8a61715c35a4c0fa43adfc018f128a\"" + "Description": "Artifact hash for asset \"a69aadbed84d554dd9f2eb7987ffe5d8f76b53a86f1909059df07050e57bef0c\"" }, - "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3Bucket670DC328": { + "AssetParameters8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64S3BucketAA0CCE0D": { "Type": "String", - "Description": "S3 bucket for asset \"3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136\"" + "Description": "S3 bucket for asset \"8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64\"" }, - "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136S3VersionKeyD4E56B7F": { + "AssetParameters8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64S3VersionKey3012C8DD": { "Type": "String", - "Description": "S3 key for asset version \"3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136\"" + "Description": "S3 key for asset version \"8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64\"" }, - "AssetParameters3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136ArtifactHash7D7D6F72": { + "AssetParameters8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64ArtifactHashFBD3EEB7": { "Type": "String", - "Description": "Artifact hash for asset \"3b6333219e7e4458816be102a7ee3b769daff2fe08f894b6008c9063785b4136\"" + "Description": "Artifact hash for asset \"8a716921b900641df041bd35d4d1817780375a004ec952e2cab0cd621c5a4d64\"" }, "SsmParameterValueawsserviceeksoptimizedami117amazonlinux2recommendedimageidC96584B6F00A464EAD1953AFF4B05118Parameter": { "Type": "AWS::SSM::Parameter::Value", From 3db119cec97382da3277e9662ed407af9b93a1df Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 6 Oct 2020 12:50:40 +0300 Subject: [PATCH 31/36] touchups --- packages/@aws-cdk/aws-eks/README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index c46f2a3c50e65..c8fc4c7f1c07b 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -889,9 +889,6 @@ const myChart = new MyChart(new cdk8s.App(), 'MyChart', { bucket }); cluster.addCdk8sChart('my-chart', myChart); ``` -Note that at this moment, you cannot use AWS CDK constructs as scopes for CDK8s constructs, or vise versa. -This is why we use `new cdk8s.App()` as the scope of the chart itself. - ##### Custom CDK8s Constructs You can also compose a few stock `cdk8s+` constructs into your own custom construct. However, since mixing scopes between `aws-cdk` and `cdk8s` is currently not supported, the `Construct` class From aa2904ee88efe7c3dc3fe4ea318f8a3d963c174f Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 6 Oct 2020 13:00:02 +0300 Subject: [PATCH 32/36] remove misleading caveat --- packages/@aws-cdk/aws-eks/README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index c8fc4c7f1c07b..32d361135ccad 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -925,13 +925,6 @@ export class LoadBalancedWebService extends constructs.Construct { } ``` -##### Caveat - -`cdk8s+` is vended with a static version of the kubernetes API spec. See ... - -At the moment, there is no way to control which spec version `cdk8s+` uses, so if you need other versions, please refer to [Manual importing](#manually-importing-k8s-specs-and-crds) below. -This would unfortunately mean you won't be able to utilize `cdk8s+` capabilities. - ##### Manually importing k8s specs and CRD's If you find yourself unable to use `cdk8s+`, or just like to directly use the `k8s` native objects or CRD's, you can do so by manually importing them using the `cdk8s-cli`. From 85efd7f42a9e84060ab1483061f5221065a649be Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 6 Oct 2020 13:03:07 +0300 Subject: [PATCH 33/36] use 0.30.0 of cdk8s --- packages/@aws-cdk/aws-eks/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/package.json b/packages/@aws-cdk/aws-eks/package.json index 01320c3a70618..dcf8ee02c9955 100644 --- a/packages/@aws-cdk/aws-eks/package.json +++ b/packages/@aws-cdk/aws-eks/package.json @@ -91,7 +91,7 @@ "@aws-cdk/aws-ssm": "0.0.0", "@aws-cdk/core": "0.0.0", "@aws-cdk/custom-resources": "0.0.0", - "cdk8s": "^0.29.0", + "cdk8s": "^0.30.0", "constructs": "^3.0.4", "yaml": "1.10.0" }, @@ -108,7 +108,7 @@ "@aws-cdk/aws-ssm": "0.0.0", "@aws-cdk/core": "0.0.0", "@aws-cdk/custom-resources": "0.0.0", - "cdk8s": "^0.29.0", + "cdk8s": "^0.30.0", "constructs": "^3.0.4" }, "engines": { From 037b94048c4484b2586fcd692b8e9c7f091e972a Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 6 Oct 2020 13:05:58 +0300 Subject: [PATCH 34/36] use 0.30.0 of cdk8s --- packages/aws-cdk-lib/package.json | 4 ++-- packages/monocdk-experiment/package.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/aws-cdk-lib/package.json b/packages/aws-cdk-lib/package.json index 457d450308d2c..02b2d7db98e2d 100644 --- a/packages/aws-cdk-lib/package.json +++ b/packages/aws-cdk-lib/package.json @@ -259,7 +259,7 @@ "@types/node": "^10.17.35", "cdk-build-tools": "0.0.0", "constructs": "^3.0.4", - "cdk8s": "^0.29.0", + "cdk8s": "^0.30.0", "fs-extra": "^9.0.1", "pkglint": "0.0.0", "ts-node": "^9.0.0", @@ -268,7 +268,7 @@ }, "peerDependencies": { "constructs": "^3.0.4", - "cdk8s": "^0.29.0" + "cdk8s": "^0.30.0" }, "homepage": "https://github.com/aws/aws-cdk", "engines": { diff --git a/packages/monocdk-experiment/package.json b/packages/monocdk-experiment/package.json index 1ba2a80f17376..14496548649c7 100644 --- a/packages/monocdk-experiment/package.json +++ b/packages/monocdk-experiment/package.json @@ -258,7 +258,7 @@ "@types/node": "^10.17.35", "cdk-build-tools": "0.0.0", "constructs": "^3.0.4", - "cdk8s": "^0.29.0", + "cdk8s": "^0.30.0", "fs-extra": "^9.0.1", "pkglint": "0.0.0", "ts-node": "^9.0.0", @@ -267,7 +267,7 @@ }, "peerDependencies": { "constructs": "^3.0.4", - "cdk8s": "^0.29.0" + "cdk8s": "^0.30.0" }, "homepage": "https://github.com/aws/aws-cdk", "engines": { From 65f10457760b6293b864bbcbf7b0984a8954fc85 Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 6 Oct 2020 15:28:25 +0300 Subject: [PATCH 35/36] review comments --- packages/@aws-cdk/aws-eks/README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index 32d361135ccad..db9c1a0c125b5 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -821,25 +821,29 @@ chart2.node.addDependency(chart1); The EKS module natively integrates with cdk8s and allows you to apply cdk8s charts on AWS EKS clusters via the `cluster.addCdk8sChart` method. In addition to `cdk8s`, you can also use [`cdk8s+`](https://github.com/awslabs/cdk8s/tree/master/packages/cdk8s-plus), which provides higher level abstraction for the core kubernetes api objects. -You can think of it like the `L2` constructs for Kubernetes. +You can think of it like the `L2` constructs for Kubernetes. Any other `cdk8s` based libraries are also supported, for example [`cdk8s-debore`](https://github.com/toricls/cdk8s-debore). To get started, add the following dependencies to your `package.json` file: ```json -dependencies: { +"dependencies": { "cdk8s": "0.30.0", "cdk8s-plus": "0.30.0", - "constructs": "3.0.4", + "constructs": "3.0.4" } ``` > Note that the version of `cdk8s` must be `>=0.30.0`. -We recommend to seperate the `cdk8s` charts to a different file and extend the `cdk8s.Chart` class. -You can use `aws-cdk` construct attributes and properties inside your `cdk8s` construct freely. +Similarly to how you would create a stack by extending `core.Stack`, we recommend you create a chart of your own that extends `cdk8s.Chart`, +and add your kubernetes resources to it. You can use `aws-cdk` construct attributes and properties inside your `cdk8s` construct freely. In this example we create a chart that accepts an `s3.Bucket` and passes its name to a kubernetes pod as an environment variable. +Notice that the chart must accept a `constructs.Construct` type as its scope, not an `@aws-cdk/core.Construct` as you would normally use. +For this reason, to avoid possible confusion, we will create the chart in a separate file: + +`+ my-chart.ts` ```ts import * as s3 from '@aws-cdk/aws-s3'; import * as constructs from 'constructs'; @@ -847,7 +851,6 @@ import * as cdk8s from 'cdk8s'; import * as kplus from 'cdk8s-plus'; export interface MyChartProps { - readonly bucket: s3.Bucket; } @@ -867,17 +870,16 @@ export class MyChart extends cdk8s.Chart { ] } }); - } } ``` -Then, in your cdk app: +Then, in your AWS CDK app: ```ts import * as s3 from '@aws-cdk/aws-s3'; import * as cdk8s from 'cdk8s'; -import { MyChart } from './my-chart' +import { MyChart } from './my-chart'; // some bucket.. const bucket = new s3.Bucket(this, 'Bucket'); From d2436874a4c0b5b5964c2f62160b19377d0e27f5 Mon Sep 17 00:00:00 2001 From: epolon Date: Tue, 6 Oct 2020 15:29:45 +0300 Subject: [PATCH 36/36] touchup --- packages/@aws-cdk/aws-eks/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index db9c1a0c125b5..a04432a038be9 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -835,7 +835,7 @@ To get started, add the following dependencies to your `package.json` file: > Note that the version of `cdk8s` must be `>=0.30.0`. -Similarly to how you would create a stack by extending `core.Stack`, we recommend you create a chart of your own that extends `cdk8s.Chart`, +Similarly to how you would create a stack by extending `@aws-cdk/core.Stack`, we recommend you create a chart of your own that extends `cdk8s.Chart`, and add your kubernetes resources to it. You can use `aws-cdk` construct attributes and properties inside your `cdk8s` construct freely. In this example we create a chart that accepts an `s3.Bucket` and passes its name to a kubernetes pod as an environment variable.