Skip to content

Commit b320ccb

Browse files
committed
Changes after mvn... generate-docs
1 parent 0eac03b commit b320ccb

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

docs/content/docs/custom-resource/reference.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,23 @@ This serves as a full reference for FlinkDeployment and FlinkSessionJob custom r
5757
| Parameter | Type | Docs |
5858
| ----------| ---- | ---- |
5959

60+
### FlinkBlueGreenDeploymentConfigOptions
61+
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkBlueGreenDeploymentConfigOptions
62+
63+
**Description**: Configuration options to be used by the Flink Blue/Green Deployments.
64+
65+
| Parameter | Type | Docs |
66+
| ----------| ---- | ---- |
67+
68+
### FlinkBlueGreenDeploymentSpec
69+
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkBlueGreenDeploymentSpec
70+
71+
**Description**: Spec that describes a Flink application with blue/green deployment capabilities.
72+
73+
| Parameter | Type | Docs |
74+
| ----------| ---- | ---- |
75+
| template | org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentTemplateSpec | |
76+
6077
### FlinkDeploymentSpec
6178
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec
6279

@@ -78,6 +95,17 @@ This serves as a full reference for FlinkDeployment and FlinkSessionJob custom r
7895
| logConfiguration | java.util.Map<java.lang.String,java.lang.String> | Log configuration overrides for the Flink deployment. Format logConfigFileName -> configContent. |
7996
| mode | org.apache.flink.kubernetes.operator.api.spec.KubernetesDeploymentMode | Deployment mode of the Flink cluster, native or standalone. |
8097

98+
### FlinkDeploymentTemplateSpec
99+
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentTemplateSpec
100+
101+
**Description**: Template Spec that describes a Flink application managed by the blue/green controller.
102+
103+
| Parameter | Type | Docs |
104+
| ----------| ---- | ---- |
105+
| metadata | io.fabric8.kubernetes.api.model.ObjectMeta | |
106+
| configuration | java.util.Map<java.lang.String,java.lang.String> | |
107+
| spec | org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec | |
108+
81109
### FlinkSessionJobSpec
82110
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkSessionJobSpec
83111

@@ -290,6 +318,33 @@ This serves as a full reference for FlinkDeployment and FlinkSessionJob custom r
290318
| UNKNOWN | Checkpoint format unknown, if the checkpoint was not triggered by the operator. |
291319
| description | org.apache.flink.configuration.description.InlineElement | |
292320

321+
### FlinkBlueGreenDeploymentState
322+
**Class**: org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentState
323+
324+
**Description**: Enumeration of the possible states of the blue/green transition.
325+
326+
| Value | Docs |
327+
| ----- | ---- |
328+
| INITIALIZING_BLUE | We use this state while initializing for the first time, always with a "Blue" deployment type. |
329+
| ACTIVE_BLUE | Identifies the system is running normally with a "Blue" deployment type. |
330+
| ACTIVE_GREEN | Identifies the system is running normally with a "Green" deployment type. |
331+
| TRANSITIONING_TO_BLUE | Identifies the system is transitioning from "Green" to "Blue". |
332+
| TRANSITIONING_TO_GREEN | Identifies the system is transitioning from "Blue" to "Green". |
333+
334+
### FlinkBlueGreenDeploymentStatus
335+
**Class**: org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentStatus
336+
337+
**Description**: Last observed status of the Flink Blue/Green deployment.
338+
339+
| Parameter | Type | Docs |
340+
| ----------| ---- | ---- |
341+
| jobStatus | org.apache.flink.kubernetes.operator.api.status.JobStatus | |
342+
| blueGreenState | org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentState | The state of the blue/green transition. |
343+
| lastReconciledSpec | java.lang.String | Last reconciled (serialized) deployment spec. |
344+
| lastReconciledTimestamp | java.lang.String | Timestamp of last reconciliation. |
345+
| abortTimestamp | java.lang.String | Computed from abortGracePeriodMs, timestamp after which the deployment should be aborted. |
346+
| deploymentReadyTimestamp | java.lang.String | Timestamp when the deployment became READY/STABLE. Used to determine when to delete it. |
347+
293348
### FlinkDeploymentReconciliationStatus
294349
**Class**: org.apache.flink.kubernetes.operator.api.status.FlinkDeploymentReconciliationStatus
295350

0 commit comments

Comments
 (0)