If you have decided to use the custom cloud bundle variant, your site is hosted in Magnolia Cloud and you, or your cloud partner, must create and deploy the custom bundle.
To successfully deploy custom bundles to Magnolia Cloud, certain best practices must be followed when creating your project and when deploying it the first time or continuously thereafter.
Creating your custom bundle
You receive your subscription-code and access keys during the Magnolia Cloud onboarding process.
magnolia-cloud-project-archetype is supported with version 1.3+ of the Magnolia Maven Archetype.
Further instructions and best practice information are provided in your project's
The Magnolia Maven Archetype generates a best-practice project skeleton. For example:
Note that upon creation:
- Two default profiles are generated:
shared. These profiles have their own
- During packaging, the
devprofile is excluded. The
sharedprofile is included and deployed to Magnolia Cloud.
- You can add local developer credentials to the
devprofile to be used instead of the typical Magnolia superuser/superuser, which is disabled in the cloud.
- In the
sharedprofile, you can create specific
.propertiesfiles for each cloud environment. This can be used, for example, to test the integration of a third-party tool in the UAT environment without affecting your Live environment.
If you created a custom bundle before Magnolia 6.2.1 with
.properties file changes, please check your customizations carefully and adhere to the structure shown above.
Continuous integration and deployment of custom bundles
You must use the Magnolia Cloud Maven Plugin for the continuous integration and deployment (CI/CD) of custom bundles to Magnolia Cloud. The plugin validates and uploads your custom cloud bundle and deploys it to Magnolia's pipelines.
Make sure you use the latest version of the Magnolia Cloud Maven Plugin when deploying a new bundle to Magnolia Cloud: v1.0-RC6.
More information can be found in the readme here: https://git.magnolia-cms.com/projects/OD/repos/magnolia-cloud-maven-plugin/browse/README.md
Validation of the custom bundle
The plugin performs validation checks against the built artifact (webapp) to ensure compatibility with the Magnolia Cloud infrastructure:
- Basic checks for required configuration in the
- Inspection of required and blacklisted modules/jars.
Deployment of the WAR file
The plugin uploads the built artifact to the entry point for Magnolia Cloud's deployment pipelines. It also collects meta-information about the artifact for debugging purposes.
Magnolia Cloud Simulator
We recommend you test your custom bundle in a simulated cloud environment before deploying it.
To do so, we offer a docker-compose based setup: Magnolia Cloud Simulator.