Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Custom JARs for Aiven for Apache Flink overview #2291

Merged
merged 8 commits into from
Jan 18, 2024
Merged

Custom JARs for Aiven for Apache Flink overview #2291

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
380b730
Custom JARs for Aiven for Apache Flink overview
harshini-rangaswamy Nov 26, 2023
e6b53e7
Update TOC
harshini-rangaswamy Nov 26, 2023
078f6ff
fixed vale errors
harshini-rangaswamy Nov 27, 2023
106060f
Addressed review comments and updated Flink application topic
harshini-rangaswamy Dec 15, 2023
352f321
updated intro text
harshini-rangaswamy Jan 17, 2024
559ddb9
Merge branch 'main' into harshini-flink-JARs-overview
harshini-rangaswamy Jan 18, 2024
9c8a95c
added cross reference to howto page
harshini-rangaswamy Jan 18, 2024
b3d2f29
removed link
harshini-rangaswamy Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/vale/dicts/aiven.dic
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ io
iops
IPsec
iptables
JARs
java_lang_Memory
Java
JMX
Expand Down
1 change: 1 addition & 0 deletions _toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,6 +619,7 @@ entries:
- file: docs/products/flink/concepts/flink-applications
title: Aiven Flink applications
- file: docs/products/flink/concepts/supported-syntax-sql-editor
- file: docs/products/flink/concepts/custom-jars
- file: docs/products/flink/concepts/tables
title: Flink tables
- file: docs/products/flink/concepts/checkpoints
Expand Down
31 changes: 31 additions & 0 deletions docs/products/flink/concepts/custom-jars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Custom JARs in Aiven for Apache Flink®
=================================================

Aiven for Apache Flink® allows you to upload, deploy, and manage your own Java code with custom JARs. This feature aims to expand the capabilities of Aiven for Apache Flink, allowing you to add custom functions that extend beyond the typical SQL-based features. With Custom JARs, you can swiftly develop and maximize the potential of your Aiven for Flink application.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

custom should be lower case

harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved

What are custom JARs?

Check failure on line 6 in docs/products/flink/concepts/custom-jars.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/flink/concepts/custom-jars.rst#L6 

[Aiven.capitalization_headings] 'What are custom JARs?' should be in sentence case
Raw output 
{"message": "[Aiven.capitalization_headings] 'What are custom JARs?' should be in sentence case", "location": {"path": "docs/products/flink/concepts/custom-jars.rst", "range": {"start": {"line": 6, "column": 1}}}, "severity": "ERROR"}
-------------------------
Java ARchive (JAR) files are package files used in Java to aggregate many class files, metadata, and resources like text and images into a single file for distribution. Custom JARs are Java Archive files containing custom code and resources developed for specific functionalities outside standard Java or Apache Flink libraries.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add a sentence here at the end like. "The capabilities of any JAR are defined by your organisation and use cases"?



Why use custom JARs?

Check failure on line 11 in docs/products/flink/concepts/custom-jars.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/flink/concepts/custom-jars.rst#L11 

[Aiven.capitalization_headings] 'Why use custom JARs?' should be in sentence case
Raw output 
{"message": "[Aiven.capitalization_headings] 'Why use custom JARs?' should be in sentence case", "location": {"path": "docs/products/flink/concepts/custom-jars.rst", "range": {"start": {"line": 11, "column": 1}}}, "severity": "ERROR"}
---------------------
Using Custom JARs in Aiven for Apache Flink offers several key benefits:

* **Enhanced functionality:** Using custom JARs, you can extend the native capabilities of your Aiven for Apache Flink service, incorporating functionalities that go beyond the core Flink APIs.
* **Code reusability:** This feature allows you to seamlessly reuse and integrate your existing Java code into your Aiven for Apache Flink applications.

Check failure on line 16 in docs/products/flink/concepts/custom-jars.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/flink/concepts/custom-jars.rst#L16 

[Aiven.aiven_spelling] 'reusability' does not seem to be a recognised word
Raw output 
{"message": "[Aiven.aiven_spelling] 'reusability' does not seem to be a recognised word", "location": {"path": "docs/products/flink/concepts/custom-jars.rst", "range": {"start": {"line": 16, "column": 10}}}, "severity": "ERROR"}
* **Simplified management:** The need to deploy and manage separate Flink service is significantly reduced, as custom functionalities can be directly used within the Aiven for Apache Flink application.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved

Use cases
--------------

Custom JARs can be applied in various scenarios, including but not limited to:

* **Custom data processing and enrichment:** Custom JARs facilitate the processing and enrichment of data from sources not natively supported by Flink's core APIs. This includes implementing unique data processing logic and applying custom functions for data transformation and enrichment.

Check failure on line 24 in docs/products/flink/concepts/custom-jars.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/flink/concepts/custom-jars.rst#L24 

[Aiven.aiven_spelling] 'Flink's' does not seem to be a recognised word
Raw output 
{"message": "[Aiven.aiven_spelling] 'Flink's' does not seem to be a recognised word", "location": {"path": "docs/products/flink/concepts/custom-jars.rst", "range": {"start": {"line": 24, "column": 146}}}, "severity": "ERROR"}
* **Connector customization:** With custom JARs, it is possible to create and integrate unique connectors tailored to specific data integration needs. This feature enables users to develop and deploy connectors that are not available in Flink's standard offerings, providing a more flexible and customized data flow within their applications.

Check failure on line 25 in docs/products/flink/concepts/custom-jars.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/products/flink/concepts/custom-jars.rst#L25 

[Aiven.aiven_spelling] 'Flink's' does not seem to be a recognised word
Raw output 
{"message": "[Aiven.aiven_spelling] 'Flink's' does not seem to be a recognised word", "location": {"path": "docs/products/flink/concepts/custom-jars.rst", "range": {"start": {"line": 25, "column": 238}}}, "severity": "ERROR"}
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved


Related reading
-----------------
* How to use custom JARs in Aiven for Apache Flink application

Loading