[ 
https://issues.apache.org/jira/browse/FLINK-12998?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16882946#comment-16882946
 ] 

Piotr Nowojski edited comment on FLINK-12998 at 7/11/19 1:23 PM:
-----------------------------------------------------------------

It might be that the "batch connectors" page is a bit out of date. I agree, 
that we should document everything in one place, and the current "filesystems" 
page is probably the best candidate.

I would maybe rephrase the "batch connectors" paragraph from:

{noformat}
the required classes for using the file system are available in the lib/ folder 
of the Flink installation (on all machines running Flink).
{noformat}

to maybe something like this:

{noformat}
the required classes for using the file system must be installed
as plugins (more information HERE) or be present in the lib/ folder 
of the Flink installation. Regardless if using plugins or not, 
the file system classes must be installed on all machines running Flink.
{noformat}

with link "HERE" pointing to the "filesystems.md" page. Or maybe this paragraph 
can be even more vague:

{noformat}
the required classes for using the file system must be properly installed 
on all machines running Flink. More details about how to install a FileSystem
you can find HERE.
{noformat}



was (Author: pnowojski):
It might be that the "batch connectors" page is a bit out of date. I agree, 
that we should document everything in one place, and the current "filesystems" 
page is probably the best candidate.

I would maybe rephrase the "batch connectors" paragraph from:

{noformat}
the required classes for using the file system are available in the lib/ folder 
of the Flink installation (on all machines running Flink).
{noformat}

to maybe something like this:

{noformat}
the required classes for using the file system must be installed as plugins 
(more information HERE) or be present in the lib/ folder of the Flink 
installation. Regardless if using plugins or not, the file system classes must 
be installed on all machines running Flink.
{noformat}

with link "HERE" pointing to the "filesystems.md" page. Or maybe this paragraph 
can be even more vague:

{noformat}
the required classes for using the file system must be properly installed on 
all machines running Flink. More details about how to install a FileSystem you 
can find HERE.
{noformat}


> Document Plugins mechanism
> --------------------------
>
>                 Key: FLINK-12998
>                 URL: https://issues.apache.org/jira/browse/FLINK-12998
>             Project: Flink
>          Issue Type: Sub-task
>          Components: FileSystems
>    Affects Versions: 1.9.0
>            Reporter: Piotr Nowojski
>            Assignee: Alex
>            Priority: Blocker
>             Fix For: 1.9.0
>
>
> Plugins mechanism must be documented before the release. We should write down:
>  * benefits
>  * how to use existing FileSystem plugins
>  * how to implement an own custom FileSystem plugin
>  * potential issues of relaying on 
> {{Thread.currentThread().getContextClassLoader()}}  (currently it's set only 
> for {{FileSystemFactory}} class loading and {{FileSystemFactory#create()}} 
> method call - if a {{FileSystem}} is accessing {{getContextClassLoader}} 
> during runtime (write/reading) it will not work properly as a plugin.



--
This message was sent by Atlassian JIRA
(v7.6.14#76016)

Reply via email to