cdk8s-plus-31 2.3.0 → 2.5.0

package/.jsii

@@ -4133,7 +4133,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/probe.ts",
-        "line": 100
+        "line": 119
       },
       "name": "CommandProbeOptions",
       "symbolId": "src/probe:CommandProbeOptions"
@@ -9137,6 +9137,63 @@
       ],
       "symbolId": "src/role-binding:Group"
     },
+    "cdk8s-plus-31.GrpcProbeOptions": {
+      "assembly": "cdk8s-plus-31",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for `Probe.fromGrpc()`."
+      },
+      "fqn": "cdk8s-plus-31.GrpcProbeOptions",
+      "interfaces": [
+        "cdk8s-plus-31.ProbeOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/probe.ts",
+        "line": 145
+      },
+      "name": "GrpcProbeOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- defaults to `container.port`.",
+            "stability": "stable",
+            "summary": "The TCP port to connect to on the container."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/probe.ts",
+            "line": 151
+          },
+          "name": "port",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- If this is not specified, the default behavior is defined by gRPC.",
+            "stability": "stable",
+            "summary": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/probe.ts",
+            "line": 158
+          },
+          "name": "service",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/probe:GrpcProbeOptions"
+    },
     "cdk8s-plus-31.Handler": {
       "assembly": "cdk8s-plus-31",
       "docs": {
@@ -9850,7 +9907,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/probe.ts",
-        "line": 74
+        "line": 86
       },
       "name": "HttpGetProbeOptions",
       "properties": [
@@ -9864,7 +9921,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 94
+            "line": 106
           },
           "name": "host",
           "optional": true,
@@ -9872,6 +9929,30 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no custom headers are set",
+            "remarks": "Note that HTTP allows repeated headers.",
+            "stability": "stable",
+            "summary": "Custom HTTP headers to set in the probe request."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/probe.ts",
+            "line": 113
+          },
+          "name": "httpHeaders",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "cdk8s-plus-31.HttpHeader"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -9882,7 +9963,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 80
+            "line": 92
           },
           "name": "port",
           "optional": true,
@@ -9900,7 +9981,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 87
+            "line": 99
           },
           "name": "scheme",
           "optional": true,
@@ -9911,6 +9992,55 @@
       ],
       "symbolId": "src/probe:HttpGetProbeOptions"
     },
+    "cdk8s-plus-31.HttpHeader": {
+      "assembly": "cdk8s-plus-31",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdk8s-plus-31.HttpHeader",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/probe.ts",
+        "line": 71
+      },
+      "name": "HttpHeader",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The HTTP Header name to be used."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/probe.ts",
+            "line": 75
+          },
+          "name": "name",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The HTTP header value to be set."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/probe.ts",
+            "line": 80
+          },
+          "name": "value",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/probe:HttpHeader"
+    },
     "cdk8s-plus-31.HttpIngressPathType": {
       "assembly": "cdk8s-plus-31",
       "docs": {
@@ -17837,7 +17967,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/probe.ts",
-        "line": 127
+        "line": 165
       },
       "methods": [
         {
@@ -17847,7 +17977,7 @@
           },
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 145
+            "line": 183
           },
           "name": "fromCommand",
           "parameters": [
@@ -17883,6 +18013,35 @@
           },
           "static": true
         },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Defines a probe based on a gRPC request to the container."
+          },
+          "locationInModule": {
+            "filename": "src/probe.ts",
+            "line": 201
+          },
+          "name": "fromGrpc",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Options."
+              },
+              "name": "options",
+              "optional": true,
+              "type": {
+                "fqn": "cdk8s-plus-31.GrpcProbeOptions"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk8s-plus-31.Probe"
+            }
+          },
+          "static": true
+        },
         {
           "docs": {
             "stability": "stable",
@@ -17890,7 +18049,7 @@
           },
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 135
+            "line": 173
           },
           "name": "fromHttpGet",
           "parameters": [
@@ -17928,7 +18087,7 @@
           },
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 154
+            "line": 192
           },
           "name": "fromTcpSocket",
           "parameters": [
@@ -21986,7 +22145,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/probe.ts",
-        "line": 107
+        "line": 126
       },
       "name": "TcpSocketProbeOptions",
       "properties": [
@@ -22000,7 +22159,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 120
+            "line": 139
           },
           "name": "host",
           "optional": true,
@@ -22018,7 +22177,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/probe.ts",
-            "line": 113
+            "line": 132
           },
           "name": "port",
           "optional": true,
@@ -90332,6 +90491,6 @@
       "symbolId": "src/imports/k8s:WindowsSecurityContextOptions"
     }
   },
-  "version": "2.3.0",
-  "fingerprint": "n9rwl4SJ+KbFOqLVzsQ0TrY5Hk1o/fMXtzEvcGmdd94="
+  "version": "2.5.0",
+  "fingerprint": "mYN3sprUO9H3lnGMgE3W5ygU3c6dhnZ8NAYlnuThCWY="
 }

package/docs/java.md

@@ -13136,6 +13136,129 @@ Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
 
 ---
 
+### GrpcProbeOptions <a name="org.cdk8s.plus31.GrpcProbeOptions"></a>
+
+Options for `Probe.fromGrpc()`.
+
+#### Initializer <a name="[object Object].Initializer"></a>
+
+```java
+import org.cdk8s.plus31.GrpcProbeOptions;
+
+GrpcProbeOptions.builder()
+//  .failureThreshold(java.lang.Number)
+//  .initialDelaySeconds(Duration)
+//  .periodSeconds(Duration)
+//  .successThreshold(java.lang.Number)
+//  .timeoutSeconds(Duration)
+//  .port(java.lang.Number)
+//  .service(java.lang.String)
+    .build();
+```
+
+##### `failureThreshold`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.failureThreshold"></a>
+
+```java
+public java.lang.Number getFailureThreshold();
+```
+
+- *Type:* `java.lang.Number`
+- *Default:* 3
+
+Minimum consecutive failures for the probe to be considered failed after having succeeded.
+
+Defaults to 3. Minimum value is 1.
+
+---
+
+##### `initialDelaySeconds`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.initialDelaySeconds"></a>
+
+```java
+public Duration getInitialDelaySeconds();
+```
+
+- *Type:* [`org.cdk8s.Duration`](#org.cdk8s.Duration)
+- *Default:* immediate
+
+Number of seconds after the container has started before liveness probes are initiated.
+
+> https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+
+---
+
+##### `periodSeconds`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.periodSeconds"></a>
+
+```java
+public Duration getPeriodSeconds();
+```
+
+- *Type:* [`org.cdk8s.Duration`](#org.cdk8s.Duration)
+- *Default:* Duration.seconds(10) Minimum value is 1.
+
+How often (in seconds) to perform the probe.
+
+Default to 10 seconds. Minimum value is 1.
+
+---
+
+##### `successThreshold`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.successThreshold"></a>
+
+```java
+public java.lang.Number getSuccessThreshold();
+```
+
+- *Type:* `java.lang.Number`
+- *Default:* 1 Must be 1 for liveness and startup. Minimum value is 1.
+
+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.
+
+---
+
+##### `timeoutSeconds`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.timeoutSeconds"></a>
+
+```java
+public Duration getTimeoutSeconds();
+```
+
+- *Type:* [`org.cdk8s.Duration`](#org.cdk8s.Duration)
+- *Default:* Duration.seconds(1)
+
+Number of seconds after which the probe times out.
+
+Defaults to 1 second. Minimum value is 1.
+
+> https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+
+---
+
+##### `port`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.port"></a>
+
+```java
+public java.lang.Number getPort();
+```
+
+- *Type:* `java.lang.Number`
+- *Default:* defaults to `container.port`.
+
+The TCP port to connect to on the container.
+
+---
+
+##### `service`<sup>Optional</sup> <a name="org.cdk8s.plus31.GrpcProbeOptions.property.service"></a>
+
+```java
+public java.lang.String getService();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* If this is not specified, the default behavior is defined by gRPC.
+
+Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+
+---
+
 ### HandlerFromHttpGetOptions <a name="org.cdk8s.plus31.HandlerFromHttpGetOptions"></a>
 
 Options for `Handler.fromHttpGet`.
@@ -13418,6 +13541,7 @@ HttpGetProbeOptions.builder()
 //  .successThreshold(java.lang.Number)
 //  .timeoutSeconds(Duration)
 //  .host(java.lang.String)
+//  .httpHeaders(java.util.List<HttpHeader>)
 //  .port(java.lang.Number)
 //  .scheme(ConnectionScheme)
     .build();
@@ -13513,6 +13637,21 @@ The host name to connect to on the container.
 
 ---
 
+##### `httpHeaders`<sup>Optional</sup> <a name="org.cdk8s.plus31.HttpGetProbeOptions.property.httpHeaders"></a>
+
+```java
+public java.util.List<HttpHeader> getHttpHeaders();
+```
+
+- *Type:* java.util.List<[`org.cdk8s.plus31.HttpHeader`](#org.cdk8s.plus31.HttpHeader)>
+- *Default:* no custom headers are set
+
+Custom HTTP headers to set in the probe request.
+
+Note that HTTP allows repeated headers.
+
+---
+
 ##### `port`<sup>Optional</sup> <a name="org.cdk8s.plus31.HttpGetProbeOptions.property.port"></a>
 
 ```java
@@ -13539,6 +13678,43 @@ Scheme to use for connecting to the host (HTTP or HTTPS).
 
 ---
 
+### HttpHeader <a name="org.cdk8s.plus31.HttpHeader"></a>
+
+#### Initializer <a name="[object Object].Initializer"></a>
+
+```java
+import org.cdk8s.plus31.HttpHeader;
+
+HttpHeader.builder()
+    .name(java.lang.String)
+    .value(java.lang.String)
+    .build();
+```
+
+##### `name`<sup>Required</sup> <a name="org.cdk8s.plus31.HttpHeader.property.name"></a>
+
+```java
+public java.lang.String getName();
+```
+
+- *Type:* `java.lang.String`
+
+The HTTP Header name to be used.
+
+---
+
+##### `value`<sup>Required</sup> <a name="org.cdk8s.plus31.HttpHeader.property.value"></a>
+
+```java
+public java.lang.String getValue();
+```
+
+- *Type:* `java.lang.String`
+
+The HTTP header value to be set.
+
+---
+
 ### IngressProps <a name="org.cdk8s.plus31.IngressProps"></a>
 
 Properties for `Ingress`.
@@ -21818,6 +21994,23 @@ Options.
 
 ---
 
+##### `fromGrpc` <a name="org.cdk8s.plus31.Probe.fromGrpc"></a>
+
+```java
+import org.cdk8s.plus31.Probe;
+
+Probe.fromGrpc()
+Probe.fromGrpc(GrpcProbeOptions options)
+```
+
+###### `options`<sup>Optional</sup> <a name="org.cdk8s.plus31.Probe.parameter.options"></a>
+
+- *Type:* [`org.cdk8s.plus31.GrpcProbeOptions`](#org.cdk8s.plus31.GrpcProbeOptions)
+
+Options.
+
+---
+
 ##### `fromHttpGet` <a name="org.cdk8s.plus31.Probe.fromHttpGet"></a>
 
 ```java