Jenkins部署War包到Tomcat时，如何添加XML Configuration file URL？

Got it, let's tackle this problem step by step. You're using Jenkins' Deploy war/ear container step and want to add an external XML configuration file (pulled from a URL) since your WAR doesn't include dependent libraries. Here's how to make this work:

Option 1: Use the Tomcat Context XML Plugin (Most Straightforward) #

This dedicated plugin adds native support for managing Tomcat context XML files in your Jenkins workflow, including fetching files directly from a URL.

1. Install the Plugin:

   • Head to Jenkins > Manage Jenkins > Plugins > Available Plugins, search for Tomcat Context XML Plugin, and install it.

2. Configure Your Job:

   • In your Jenkins job, add a new step before your existing Deploy war/ear container step. Look for "Tomcat Context XML" in the step selector.
   • Choose the "Fetch from URL" radio button, then paste your XML configuration file's URL.
   • Set the Target Context Path to match the context path you specified in your deployment step (e.g., /my-app). This ensures the XML is deployed to Tomcat's conf/Catalina/localhost/${contextPath}.xml location—Tomcat automatically uses this file for your app's configuration.
   • Run the job: The XML will be pulled from the URL and placed correctly before your WAR deploys, letting your app reference the external dependencies defined in the XML.

Option 2: Use Config File Provider + Tomcat Manager API (Flexible Alternative) #

If you want more control over the deployment process, combine the Config File Provider Plugin with direct calls to the Tomcat Manager API.

1. Install Required Plugins:

   • Install Config File Provider Plugin and Credentials Binding Plugin (to securely access your Tomcat credentials).

2. Set Up the Configuration File:

   • Go to Jenkins > Manage Jenkins > Managed Files > Add a new Config File.
   • Select "URL" as the file type, paste your XML URL, and give it a descriptive name (e.g., "App Context XML").

3. Configure Your Job:

   • Add a "Provide config files" step to your job. Select the XML file you created, and specify a path in the build workspace to save it (e.g., ./app-context.xml).
   • Replace or supplement the Deploy war/ear container step with an Execute Shell (or Windows Batch) step. Use curl to call the Tomcat Manager API, deploying both the WAR and the XML. Example command (replace variables with your values):

     # Use Jenkins credentials binding to inject Tomcat username/password
     curl -u "${TOMCAT_USER}:${TOMCAT_PASS}" \
         -T ./your-app.war \
         "http://${TOMCAT_URL}/manager/text/deploy?path=${CONTEXT_PATH}&config=file://${WORKSPACE}/app-context.xml&update=true"
     

   • This command deploys your WAR and tells Tomcat to use the downloaded XML for your app's configuration.

Option 3: Custom Plugin Modification (Advanced) #

If neither of the above options fits your specific needs, you could modify the core Deploy to Container Plugin to add a dedicated "XML Configuration file URL" field. This requires Java development knowledge and is only recommended if you have unique custom requirements that can't be met with existing tools.

Key Notes #

• Double-check that the XML's configuration (like JNDI names for data sources) matches exactly what your WAR expects.
• Test the deployment in a staging environment first to confirm the XML is being picked up correctly by Tomcat.

内容的提问来源于stack exchange，提问作者user6543599