Developing for Magnolia in the cloud

This page gives an overview of the Magnolia development cycle for standard and custom bundles.

Standard Cloud bundle development workflow

Depending on your subscription package, the environments available to you may differ.

For example, you may have only a single Live environment available, or only a UAT and a Live environment. In these cases, you can install a development snapshot directly in the Live or in the UAT environment respectively.

Local development

Creating new features and functions in your Magnolia package starts with local development. After cloning the remote Git repository linked to your Magnolia subscription package, you install a Magnolia local development bundle on your machine. This is where you develop new features before sending them to the cloud via the Git repository.

Have a look at the prerequisites below before you get started.

Working in Magnolia

After developing locally and pushing your work to the Magnolia Git repository, log in to the cockpit to retrieve your work. As well as providing an overview of your package's status, the cockpit is the starting point for all the actions you can do in Magnolia in the cloud:

Install updates using Magnolia - Create development snapshots and releases to deploy and test new features through the different environments in Magnolia before making your site available to your customers.
Manage environments in Magnolia - Create and manage the environments and running instances of Magnolia in the cloud.

Prerequisites

Java

Java 1.8 or higher is required to run the Magnolia local development bundle. If you do not know whether you have Java installed or which version you have, please read get Java.

Git

Git is required to develop for Magnolia in the cloud. You need:

Best practice

Magnolia recommends that you develop your light module files using Magnolia CLI. If you want to use it, you have to install it. Magnolia light modules can nonetheless also be developed without using Magnolia CLI.

See Setting up a local Git repository to get started with your standard bundle development workflow.

Custom cloud bundle development workflow

In the case of custom cloud bundle implementations, the development workflow is different. You or your cloud partner create the Magnolia bundle that is deployed to the cloud.

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. Once your custom bundle is deployed to the cloud, you can also work with Magnolia Cloud using both Light Development (as described above) and Java custom modules.

See Creating and deploying custom cloud bundles.

Hands-on learning

Try out our end-to-end Hello-cloud development tutorial, in which you set up a light module and deploy it in Magnolia.

Page tree