Review Board 1.7.22


Adding notes to Developer Guide upgrading Protocol Buffer version

Review Request #15956 - Created Dec. 3, 2013 and updated

Roshan Naik
flume-1.5
FLUME-2175
Reviewers
Flume
flume-git
Adding notes to Developer Guide upgrading Protocol Buffer version

 

Diff revision 1 (Latest)

  1. flume-ng-doc/sphinx/FlumeDeveloperGuide.rst: Loading...
flume-ng-doc/sphinx/FlumeDeveloperGuide.rst
Revision 2be9c68 New Change
[20] 111 lines
[+20]
112

    
   
112

   
113
Please note that Flume builds requires that the Google Protocol Buffers compiler
113
Please note that Flume builds requires that the Google Protocol Buffers compiler
114
be in the path. You can download and install it by following the instructions
114
be in the path. You can download and install it by following the instructions
115
`here <https://developers.google.com/protocol-buffers/>`_.
115
`here <https://developers.google.com/protocol-buffers/>`_.
116

    
   
116

   

    
   
117
Updating Protocol Buffer Version

    
   
118
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    
   
119
File channel has a dependency on Protocol Buffer. When updating the version of Protocol Buffer

    
   
120
used by Flume, it is necessary to regenerate the data access classes using the protoc compiler

    
   
121
that is part of Protocol Buffer as follows.

    
   
122

   

    
   
123
#. Install the desired version of Protocol Buffer on your local machine

    
   
124
#. Update version of Protocol Buffer in pom.xml

    
   
125
#. Generate new Protocol Buffer data access classes in Flume: ``cd flume-ng-channels/flume-file-channel; mvn -P compile-proto clean package -DskipTests``

    
   
126
#. Add Apache license header to any of the generated files that are missing it

    
   
127
#. Rebuild and test Flume:  ``cd ../..; mvn clean install``

    
   
128

   
117
Developing custom components
129
Developing custom components
118
----------------------------
130
----------------------------
119

    
   
131

   
120
Client
132
Client
121
~~~~~~
133
~~~~~~
[+20] [20] 619 lines
  1. flume-ng-doc/sphinx/FlumeDeveloperGuide.rst: Loading...