27.7. Provisioning Bundles
27.7.1. Managing Bundle Groups
27.7.1.1. Creating Bundle Groups
- Click the Bundles tab in the top menu.
- In the Bundle Groups area at the bottom, click the button.
- Enter a name and description for the group.
- Select the group members. If any bundles have been uploaded, then they can be added to the group when it created.Alternatively, bundles can be added to a bundle group when they are created, updated, or by editing the group.
- Click thebutton.
27.7.1.2. Assigning Bundles to Bundle Groups

Figure 27.4. Bundle Groups and Unassigned Bundles in the Bundle Hierarchy
Important
- Click the Bundles tab in the top menu.
- In the Bundle Groups area at the bottom, click the name of the bundle group to edit.
- Select the group members to add or remove from the group. When a bundle is selected in a box, the corresponding arrow becomes active to move it to the other box.
- Click thebutton.
27.7.2. Uploading Bundles to JBoss ON
Note
- In the top menu, click the Bundles tab.
- At the bottom of the Bundles section, click the button.
- Upload the distribution package or the recipe file.There are three options on how the bundle distribution is made available to the JBoss ON server:
- URL points to any URL, such as an FTP site or SVN or GIT repo, where there is a complete bundle distribution file available. If the repository requires authentication, then the username and password for a user account can be given to allow the server to authenticate to the site.
Note
Using an SVN or GIT repo allows you to pull the packages directly from a build system. - Upload uploads a single bundle distribution file (which includes both the recipe an all associated files) from the local system to the JBoss ON server.
- Recipe uploads a recipe file only, and then any additional files required for the bundle are uploaded separately. This option includes an edit field where the uploaded recipe can be edited before it is sent to the server.
- Select any groups in the left box to which to assign the bundle, and click the arrow to move it to the Assigned box.Bundle groups are required for access control. Without a group assignment, users are unable to view bundles (unless they have the global view bundles permission) or to deploy the bundles.
- Upload any associated files that were not uploaded previously. For the URL and Upload, all of the files are usually uploaded in a single file, so there is nothing to do on this screen. For the Recipe option, all of the files listed in the recipe must be uploaded manually at this step.
- The final screen shows all of the information for the new bundle. Clickto save the new bundle.
27.7.3. Deploying Bundles to a Resource
- In the top menu, click the Bundles tab.
- Scroll to the bottom of the window and click thebutton.Alternatively, click the name of the bundle in the list, and then click the deploy button at the top of the bundle page.
- Select the bundles to deploy from the list on the left and use the arrows to move them to the box on the right.
- Once the bundles are selected, define the destination information.The destination is a combination of the resources the bundle is deployed on and the directory to which is it deployed. Each destination is uniquely defined for each bundle.To define the destination, first select the resource group from the Resource drop-down menu. The resource group identifies the type of resource to which the bundle is being deployed, and the resource type defines other deployment parameters. When the group is selected, then the base location is defined. For a platform, this is the root directory. For a JBoss AS instance, it is the installation directory. For custom resources, the base location is defined in the plug-in descriptor.
Note
If you haven't created a compatible group or if you want to create a new group specifically for this bundle deployment, click the+
icon to create the group. Then, continue with the provisioning process.Set the actual deployment directory to which to deploy the bundle. This directory is a relative path to the plug-in-defined base location. - Select the version of the bundle to deploy. If there are multiple versions of a bundle available, then any of those versions can be selected. There are also quick options to deploy the latest version or the currently deployed version.
- If there are any user-defined properties, then they are entered in the fields in the next page. User-defined properties are configured in the bundle recipe using tokens.
- Fill in the information about the specific deployment instance. The checkbox sets the option on whether to overwrite anything in the existing deployment directory or whether to preserve any existing files.
- The final screen shows the progress for deploying the packages. Click Finish to complete the deployment.
27.7.4. Viewing the Bundle Deployment History

Figure 27.5. Bundles, Versions, and Destinations

Figure 27.6. Deployment Information for a Version

Figure 27.7. Deployment History for a Destination
27.7.5. Reverting a Deployed Bundle
- In the top menu, click the Bundles tab.
- In the left navigation window, expand the bundle node, and then open the Destinations folder beneath it.
- Select the destination from the left navigation.
- In the main window for the destination, click thebutton.
- The next page shows the summary of the current deployment and the immediate previous deployment, which it will be reverted to.
- Add any notes to the revert action. Optionally, select the checkbox to clean the deployment directory and install the previous version fresh.
- Click Finish on the final screen to complete the rollback.
27.7.6. Deploying a Bundle to a Clean Destination
- Preserve the existing files and directories, with appropriate upgrades, according to the recipe configuration (Section 27.5.7.3, “WARNING: The Managed (Target) Directory and Overwriting or Saving Files”)
- Completely overwrite the existing files and deploy the bundle in an empty directory

27.7.7. Purging a Bundle from a Resource
Important
compliance=full
). If the deployment directory is used by other applications – like an app server deploy/
directory — then those other applications or files will also be deleted. After purging, there is no live deployment and nothing to revert.
- In the top menu, click the Bundles tab.
- In the left navigation window, expand the bundle node, and then open the Destinations folder beneath it.
- Select the destination from the left navigation.
- In the main window for the destination, click thebutton.
- When prompted, confirm that you want to remove the bundled application and configuration from the target resources.
27.7.8. Upgrading Ant Bundles
- If the hash code on the new file is different than the original file and there are no local modifications, then JBoss ON installs the new file over the existing file.
- If the hash code on the new file is different than the original file and there are local modifications, then JBoss ON backs up the original file and installs the new file.
- If the hash code on the new file and the original file is the same and there are local modifications on the original file, then the provisioning process preserves the original file, in place.
- If there was no file in the previous bundle but there is one in the new bundle, then the new file is used and any file that was added manually is backed up.
backup/
directory within the deployment's destination directory. If the original file was located outside the application's directory (like, it was stored according to an absolute location rather than a relative location), then it is saved in an ext-backup/
directory within the deployment's destination directory.
Note
27.7.9. Deleting a Bundle from the JBoss ON Server
- In the top menu, click the Bundles tab.
- In the left navigation window, expand the bundle node, and then open the Destinations folder beneath it.
- Select the destination from the left navigation.
- In the main window for the destination, click thebutton.
- When prompted, confirm that you want to delete the bundle.