Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding support for printing to work with a shared volume (cloud environment) #25

Merged
merged 9 commits into from
Oct 14, 2024
Merged

Adding support for printing to work with a shared volume (cloud environment) #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ca4941c
Adding Support for reading the tempfile from the disk
ritika-t-thakur-alb Oct 3, 2024
fc73783
Adding Support for reading the tempfile from the disk
ritika-t-thakur-alb Oct 4, 2024
d7cfbb4
Adding Support for reading the tempfile from the disk
ritika-t-thakur-alb Oct 4, 2024
7cbe37d
Merge pull request #1 from tiago-s-vieira-alb/persistentVolume
tiago-s-vieira-alb Oct 4, 2024
e6d0d7c
Adding support for printing to work with a shared volume (cloud envir…
ritika-t-thakur-alb Oct 7, 2024
725ee00
Adding support for printing to work with a shared volume (cloud envir…
ritika-t-thakur-alb Oct 7, 2024
9ad615a
Adding support for printing to work with a shared volume (cloud envir…
ritika-t-thakur-alb Oct 7, 2024
a1ef30b
Merge branch 'mapfish:main' into persistentVolume
ritika-t-thakur-alb Oct 10, 2024
e21f03b
Merge branch 'persistentVolume' of https://github.com/tiago-s-vieira-…
ritika-t-thakur-alb Oct 10, 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
7 changes: 7 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,10 @@ Once ImageMagick is installed (and Ghostscript) then the spring configuration ne
Since the ImageMagick support is a commonly requested configuration there is an IMAGEMAGICK artifact prebuild with the correct configuration. To use this artifact change your maven dependency from: print-servlet-1.2-SNAPSHOT to print-servlet-1.2-SNAPSHOT-IMG-MAGICK (you will likely have to change the 1.2-SNAPSHOT portion to the version of mapfish that you are using).

By default ImageMagick will try to find the convert tool in /usr/bin/convert. You will want to find the path to your convert tool and update imagemagick-spring-application-context-override.xml if that file is included in your build, or mapfish-spring-application-context.xml if you manually changed the mapfish-spring-application-context.xml file to include the imagemagick configuration.


Defining temp work directory for Printing module
----------------------

MAPFISH_PDF_FOLDER : optional environment variable to define the directory path for storing printouts generated by the printing module. When not defined default value is from MapPrinterServlet context
In case of cloud environment a pvc(persistence volume claim) or a shared volume mount can be passed to the variable MAPFISH_PDF_FOLDER and hence the data can be synched between multiple instances of server.
6 changes: 4 additions & 2 deletions docs/upgrade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Upgrade
Version 2.3.2
-------------

Under development.
* Support for printing in a cloud environment and in an environment without sticky sessions : generates a requested printout metadata json file and stores it in the tempDir. With this information persisted, there is no need for sticky sessions and printing module can be used in a cloud environment with shared volume.
Copy link
Collaborator

Choose a reason for hiding this comment

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

So how does this work in a could environment - don’t they need to share a temp folder or something?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @jodygarnett ,
I elaborated my documentation a bit more.
Answering your question: depending on the cloud environment, engineers an pick an option to share a volume between multiple instances and pass the path in the existing MAPFISH_PDF_FOLDER environment variable.
I have already updated installation.rst file with the documentation for MAPFISH_PDF_FOLDER.

I think the steps for creating a shared volume is not related with this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @jodygarnett, i think everything is done from our side.
Do you need more information?

In case of cloud environment a pvc(persistence volume claim) or a shared volume mount can be used to sync this data between multiple instances of server, where as in case of non-cloud environment the tempDir can be shared between muiltiple instances running on the same machine. This path can be passed by setting the environment variable MAPFISH_PDF_FOLDER.


Version 2.3.1
-------------
Expand Down Expand Up @@ -69,4 +71,4 @@ Release notes:
Developers using mapfish-print-v2 as a library are adivsed:

* packages `com.itextpdf.text` change to `com.lowagie.text`
* `com.itextpdf.text.BaseColor` changes to `java.awt.Color`
* `com.itextpdf.text.BaseColor` changes to `java.awt.Color`
Loading
Loading