morhidi commented on code in PR #209: URL: https://github.com/apache/flink-kubernetes-operator/pull/209#discussion_r871590765
########## docs/content/docs/custom-resource/overview.md: ########## @@ -146,9 +148,51 @@ For Session clusters the operator only provides very basic management and monito - Monitor overall cluster health - Stop / Delete Session clsuter +## FlinkSessionJob + +The FlinkSessionJob have the similar structure with FlinkDeployment with the following required fields: + +``` +apiVersion: flink.apache.org/v1beta1 +kind: FlinkSessionJob +metadata: + name: basic-session-job-example +spec: + deploymentName: basic-session-cluster + job: + jarURI: https://repo1.maven.org/maven2/org/apache/flink/flink-examples-streaming_2.12/1.14.4/flink-examples-streaming_2.12-1.14.4-TopSpeedWindowing.jar + parallelism: 4 + upgradeMode: stateless +``` + +### FlinkSessionJob spec overview + +The spec contains the information to submit a session job to the session cluster. Mostly, it will define at least the following fields: + + - deploymentName: The name of the target session cluster's CR + - job: The Spec of the Session Job + +The job spec is similar field with the application job, but the jarURI can support different source. It supports the http and filesystem based +jarURI. It leverages the [Flink filesystem](https://nightlies.apache.org/flink/flink-docs-master/docs/deployment/filesystems/overview/) mechanism to download the jar and submit to the session cluster. +So the FlinkSessionJob must be run with an existing session cluster managed by the FlinkDeployment. + +To support jar from different filesystem, you should extend the base docker image as below, and put the related filesystem jar to the plugin dir. Review Comment: nit: filesystems plural ########## docs/content/docs/custom-resource/overview.md: ########## @@ -24,13 +24,15 @@ specific language governing permissions and limitations under the License. --> -# FlinkDeployment Overview +# Overview Review Comment: It'd be great to add a paragraph explaining why we need the two operational model: - Flink application - Empty Flink session + multiple jobs ########## docs/content/docs/custom-resource/overview.md: ########## @@ -24,13 +24,15 @@ specific language governing permissions and limitations under the License. --> -# FlinkDeployment Overview +# Overview -The core user facing API of the Flink Kubernetes Operator is the FlinkDeployment Custom Resource (CR). +The core user facing API of the Flink Kubernetes Operator is the FlinkDeployment and FlinkSessionJob Custom Resource (CR). Review Comment: nit: plural Custom Resources ########## docs/content/docs/custom-resource/overview.md: ########## @@ -146,9 +148,51 @@ For Session clusters the operator only provides very basic management and monito - Monitor overall cluster health - Stop / Delete Session clsuter +## FlinkSessionJob + +The FlinkSessionJob have the similar structure with FlinkDeployment with the following required fields: + +``` +apiVersion: flink.apache.org/v1beta1 +kind: FlinkSessionJob +metadata: + name: basic-session-job-example +spec: + deploymentName: basic-session-cluster + job: + jarURI: https://repo1.maven.org/maven2/org/apache/flink/flink-examples-streaming_2.12/1.14.4/flink-examples-streaming_2.12-1.14.4-TopSpeedWindowing.jar Review Comment: The Flink version should be 1.15 I guess ########## docs/content/docs/custom-resource/overview.md: ########## @@ -146,9 +148,51 @@ For Session clusters the operator only provides very basic management and monito - Monitor overall cluster health - Stop / Delete Session clsuter +## FlinkSessionJob + +The FlinkSessionJob have the similar structure with FlinkDeployment with the following required fields: Review Comment: wording: have a similar structure to FlinkDeployment ########## docs/content/docs/custom-resource/overview.md: ########## @@ -146,9 +148,51 @@ For Session clusters the operator only provides very basic management and monito - Monitor overall cluster health - Stop / Delete Session clsuter +## FlinkSessionJob + +The FlinkSessionJob have the similar structure with FlinkDeployment with the following required fields: + +``` +apiVersion: flink.apache.org/v1beta1 +kind: FlinkSessionJob +metadata: + name: basic-session-job-example +spec: + deploymentName: basic-session-cluster + job: + jarURI: https://repo1.maven.org/maven2/org/apache/flink/flink-examples-streaming_2.12/1.14.4/flink-examples-streaming_2.12-1.14.4-TopSpeedWindowing.jar + parallelism: 4 + upgradeMode: stateless +``` + +### FlinkSessionJob spec overview + +The spec contains the information to submit a session job to the session cluster. Mostly, it will define at least the following fields: + + - deploymentName: The name of the target session cluster's CR + - job: The Spec of the Session Job Review Comment: nit: the specification for ########## docs/content/docs/custom-resource/overview.md: ########## @@ -146,9 +148,51 @@ For Session clusters the operator only provides very basic management and monito - Monitor overall cluster health - Stop / Delete Session clsuter +## FlinkSessionJob + +The FlinkSessionJob have the similar structure with FlinkDeployment with the following required fields: + +``` +apiVersion: flink.apache.org/v1beta1 +kind: FlinkSessionJob +metadata: + name: basic-session-job-example +spec: + deploymentName: basic-session-cluster + job: + jarURI: https://repo1.maven.org/maven2/org/apache/flink/flink-examples-streaming_2.12/1.14.4/flink-examples-streaming_2.12-1.14.4-TopSpeedWindowing.jar + parallelism: 4 + upgradeMode: stateless +``` + +### FlinkSessionJob spec overview + +The spec contains the information to submit a session job to the session cluster. Mostly, it will define at least the following fields: + + - deploymentName: The name of the target session cluster's CR + - job: The Spec of the Session Job + +The job spec is similar field with the application job, but the jarURI can support different source. It supports the http and filesystem based Review Comment: wording: The job specification has the same structure in FlinkSessionJobs and FlinkDeployments, but in FlinkSessionJobs the jarUri can contain remote sources too. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
