Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 13

...

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. 

Table of Contents

Creating your custom bundle

...

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 magnolia.properties file conventions

This section support Cloud customers using different profiles and variables on different Magnolia Cloud supported environment.

Note

Applies to custom cloud bundle implementations only.

From Magnolia 6.2.1, Magnolia provides a cloud-specific option in the Magnolia Maven Archetype to facilitate the creation of your cloud bundles.

The Magnolia Maven Archetype generates a best-practice project skeleton. The Magnolia Cloud Maven Plugin validates and uploads your custom cloud bundle.

...

my-mgnl-cloud-webapp/
├── pom.xml
└── src
    └── main
        └── webapp
            └── WEB-INF
                └── config
                    └── dev
                    │   └── README.md
                    │   └── magnolia.properties
                    └── shared
                        └── README.md
                        └── magnolia.properties

Note:

  • Two default profiles are generated: dev and shared. These profiles have their own magnolia.properties files. 
  • During packaging, the dev profile is excluded. The shared profile is included and deployed to Magnolia Cloud.
  • You can add local developer credentials to the dev profile to be used instead of the typical Magnolia superuser/superuser, which is disabled in the cloud.
  • In the shared profile, you can create specific .properties files 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. 

Make sure you use the latest version of the Magnolia Cloud Maven Plugin when deploying a new bundle to Magnolia Cloud: v1.0-RC6.

Warning

If you previously created a custom bundle with .properties file changes, please check your customizations carefully and adhere to the structure shown above.

More information can be found in the readme here: https://git.magnolia-cms.com/projects/OD/repos/magnolia-cloud-maven-plugin/browse/README.md

...

.

Magnolia Cloud Simulator

We recommend you test your custom bundle in a simulated cloud environment before deploying it.

...