Skip to content

Commit 64b2525

Browse files
authored
[hotfix] [docs] reference.md: Add missing FlinkSessionJob CRD
1 parent 5039e0c commit 64b2525

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ specific language governing permissions and limitations
2222
under the License.
2323
-->
2424

25-
# FlinkDeployment Reference
25+
# Custom Resource Defintion Reference
2626

27-
This page serves as a full reference for FlinkDeployment custom resource definition including all the possible configuration parameters.
27+
This serves as a full reference for FlinkDeployment and FlinkSessionJob custom resource definitions, including all possible configuration parameters.
2828

2929
## FlinkDeployment
3030
**Class**: org.apache.flink.kubernetes.operator.crd.FlinkDeployment
@@ -36,6 +36,16 @@ This page serves as a full reference for FlinkDeployment custom resource definit
3636
| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkDeploymentSpec | Spec that describes a Flink application or session cluster deployment. |
3737
| status | org.apache.flink.kubernetes.operator.crd.status.FlinkDeploymentStatus | Last observed status of the Flink deployment. |
3838

39+
## FlinkSessionJob
40+
**Class**: org.apache.flink.kubernetes.operator.crd.FlinkSessionJob
41+
42+
**Description**: Custom resource that represents a session job deployment.
43+
44+
| Parameter | Type | Docs |
45+
| ----------| ---- | ---- |
46+
| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkSessionJobSpec | Spec that describes a session job deployment. |
47+
| status | org.apache.flink.kubernetes.operator.crd.status.FlinkSessionJobStatus | Last observed status of the session job deployment. |
48+
3949
## Spec
4050

4151
### FlinkDeploymentSpec

docs/template/crd-ref.template

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ specific language governing permissions and limitations
2222
under the License.
2323
-->
2424

25-
# FlinkDeployment Reference
25+
# Custom Resource Defintion Reference
2626

27-
This page serves as a full reference for FlinkDeployment custom resource definition including all the possible configuration parameters.
27+
This serves as a full reference for FlinkDeployment and FlinkSessionJob custom resource definitions, including all possible configuration parameters.
2828

2929
## FlinkDeployment
3030
**Class**: org.apache.flink.kubernetes.operator.crd.FlinkDeployment
@@ -35,3 +35,13 @@ This page serves as a full reference for FlinkDeployment custom resource definit
3535
| ----------| ---- | ---- |
3636
| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkDeploymentSpec | Spec that describes a Flink application or session cluster deployment. |
3737
| status | org.apache.flink.kubernetes.operator.crd.status.FlinkDeploymentStatus | Last observed status of the Flink deployment. |
38+
39+
## FlinkSessionJob
40+
**Class**: org.apache.flink.kubernetes.operator.crd.FlinkSessionJob
41+
42+
**Description**: Custom resource that represents a session job deployment.
43+
44+
| Parameter | Type | Docs |
45+
| ----------| ---- | ---- |
46+
| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkSessionJobSpec | Spec that describes a session job deployment. |
47+
| status | org.apache.flink.kubernetes.operator.crd.status.FlinkSessionJobStatus | Last observed status of the session job deployment. |

0 commit comments

Comments
 (0)