Skip to content

Commit 3d5f0e7

Browse files
committed
improve README
1 parent b8bc7d7 commit 3d5f0e7

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@ The OKE cluster template features the following:
1919

2020
## Getting started with Apache Flink Operator
2121

22-
Get more details with the official [Apache Flink operator documentation](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/docs/try-flink-kubernetes-operator/quick-start/)
22+
The Operator is deployed in the cluster, and offers two modes of operation:
2323

24-
Once the Operator is deployed in the cluster, there are tow possible modes of operation:
24+
### Application Mode
2525

26-
- Application Mode: in this mode flink job are deployed independently, creating a Job Manager and Task Manager(s) for each Job. It is the preferred way of using the operator if the Job code is packaged in a Docker image. In this mode, since a Job Manager is deployed per job, the UI access is also per job and one needs to connect to the specfic Job Manager REST service.
26+
In this mode flink job are deployed independently, creating a Job Manager and Task Manager(s) for each Job. It is the preferred way of using the operator if the Job code is packaged in a Docker image. In this mode, since a Job Manager is deployed per job, the UI access is also per job and one needs to connect to the specfic Job Manager REST service.
2727

28-
- Session Mode: in session mode, a FlinkDeployment creates a JobManager (or more if High Availability is configured), and then FlinkSessionJob can be created that uses that Job Manager. The advantage is that the UI is accessible in one place, however Job code needs to be staged on a remote location (like an Object Storage bucket). On OCI, the code can be stored on storage bucket and made accessible through a Pre-authenticated Request, or S3 compatibility file system needs to have been configured as a plugin to reference the jar (the difference between the two is in the way to control access)
28+
### Session Mode
29+
30+
In session mode, a FlinkDeployment creates a JobManager (or more if High Availability is configured), and then FlinkSessionJob can be created that uses that Job Manager. The advantage is that the UI is accessible in one place, however Job code needs to be staged on a remote location (like an Object Storage bucket). On OCI, the code can be stored on storage bucket and made accessible through a Pre-authenticated Request, or S3 compatibility file system needs to have been configured as a plugin to reference the jar (the difference between the two is in the way to control access)
2931

3032
The demo job referenced in the docs uses Application Mode.
3133

@@ -128,6 +130,27 @@ spec:
128130
upgradeMode: stateless # Use savepoint if state management is configuered. `last-state` is not supported.
129131
```
130132
133+
## Use the Terraform template
134+
135+
To use the Terraform template locally, configure the OCI Command Line Interface with a Private/Public key pair added to your user.
136+
137+
Create a `terraform.tvfars` from the `terraform.tvfars.template` file and fill in the values for the variables.
138+
139+
Run:
140+
141+
```bash
142+
# init the repo
143+
terraform init
144+
# check the plan
145+
terraform plan
146+
# deploy
147+
terraform apply
148+
```
149+
150+
## References
151+
152+
- [Apache Flink operator documentation](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/docs/try-flink-kubernetes-operator/quick-start/)
153+
131154

132155
[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
133156
[magic_oke_flink_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/streamnsight/oke-flink/releases/latest/download/oke-flink.zip

0 commit comments

Comments
 (0)