This is an automated email from the ASF dual-hosted git repository.
gyfora pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 64b25257 [hotfix] [docs] reference.md: Add missing FlinkSessionJob CRD
64b25257 is described below
commit 64b252577e8de579a992103c81555a579c013716
Author: Matt Braymer-Hayes <[email protected]>
AuthorDate: Mon Jun 17 03:17:55 2024 -0700
[hotfix] [docs] reference.md: Add missing FlinkSessionJob CRD
---
docs/content/docs/custom-resource/reference.md | 14 ++++++++++++--
docs/template/crd-ref.template | 14 ++++++++++++--
2 files changed, 24 insertions(+), 4 deletions(-)
diff --git a/docs/content/docs/custom-resource/reference.md
b/docs/content/docs/custom-resource/reference.md
index 9db6371e..a5216daa 100644
--- a/docs/content/docs/custom-resource/reference.md
+++ b/docs/content/docs/custom-resource/reference.md
@@ -22,9 +22,9 @@ specific language governing permissions and limitations
under the License.
-->
-# FlinkDeployment Reference
+# Custom Resource Defintion Reference
-This page serves as a full reference for FlinkDeployment custom resource
definition including all the possible configuration parameters.
+This serves as a full reference for FlinkDeployment and FlinkSessionJob custom
resource definitions, including all possible configuration parameters.
## FlinkDeployment
**Class**: org.apache.flink.kubernetes.operator.crd.FlinkDeployment
@@ -36,6 +36,16 @@ This page serves as a full reference for FlinkDeployment
custom resource definit
| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkDeploymentSpec |
Spec that describes a Flink application or session cluster deployment. |
| status |
org.apache.flink.kubernetes.operator.crd.status.FlinkDeploymentStatus | Last
observed status of the Flink deployment. |
+## FlinkSessionJob
+**Class**: org.apache.flink.kubernetes.operator.crd.FlinkSessionJob
+
+**Description**: Custom resource that represents a session job deployment.
+
+| Parameter | Type | Docs |
+| ----------| ---- | ---- |
+| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkSessionJobSpec |
Spec that describes a session job deployment. |
+| status |
org.apache.flink.kubernetes.operator.crd.status.FlinkSessionJobStatus | Last
observed status of the session job deployment. |
+
## Spec
### FlinkDeploymentSpec
diff --git a/docs/template/crd-ref.template b/docs/template/crd-ref.template
index 835fd90b..acbc3a78 100644
--- a/docs/template/crd-ref.template
+++ b/docs/template/crd-ref.template
@@ -22,9 +22,9 @@ specific language governing permissions and limitations
under the License.
-->
-# FlinkDeployment Reference
+# Custom Resource Defintion Reference
-This page serves as a full reference for FlinkDeployment custom resource
definition including all the possible configuration parameters.
+This serves as a full reference for FlinkDeployment and FlinkSessionJob custom
resource definitions, including all possible configuration parameters.
## FlinkDeployment
**Class**: org.apache.flink.kubernetes.operator.crd.FlinkDeployment
@@ -35,3 +35,13 @@ This page serves as a full reference for FlinkDeployment
custom resource definit
| ----------| ---- | ---- |
| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkDeploymentSpec |
Spec that describes a Flink application or session cluster deployment. |
| status |
org.apache.flink.kubernetes.operator.crd.status.FlinkDeploymentStatus | Last
observed status of the Flink deployment. |
+
+## FlinkSessionJob
+**Class**: org.apache.flink.kubernetes.operator.crd.FlinkSessionJob
+
+**Description**: Custom resource that represents a session job deployment.
+
+| Parameter | Type | Docs |
+| ----------| ---- | ---- |
+| spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkSessionJobSpec |
Spec that describes a session job deployment. |
+| status |
org.apache.flink.kubernetes.operator.crd.status.FlinkSessionJobStatus | Last
observed status of the session job deployment. |
