AEM Compose - Pulumi Native Provider

This provider allows development teams to easily set up Adobe Experience Manager instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the AEM Compose tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge.

Published in Pulumi Registry.

References

• Talk at AdaptTo 2024 Conference - First-ever IaC Providers for AEM by Krystian Panek

Purpose

The main purpose of this provider is to enable users to:

• Set up as many AEM environments as needed with minimal effort
• Eliminate the need for deep DevOps knowledge
• Allow for seamless integration with popular cloud platforms such as AWS and Azure
• Provide a simple and efficient way to manage AEM instances

Features

• Easy configuration and management of AEM instances
• Support for multiple cloud platforms and bare metal machines
• Seamless integration with Pulumi for infrastructure provisioning
• Based on the powerful AEM Compose tool

Quickstart

The easiest way to get started is to review, copy and adapt provided examples:

1. AWS EC2 instance with private IP
   • Go
   • NodeJS
   • Python
   • .NET
2. AWS EC2 instance with public IP
   • Go
   • NodeJS
   • Python
   • .NET
3. Bare metal machine
   • Go
   • NodeJS
   • Python
   • .NET

---

Development

This repository is showing how to create and locally test a native Pulumi provider.

Authoring a Pulumi Native Provider

This creates a working Pulumi-owned provider named aem. It implements a random number generator that you can build and test out for yourself and then replace the Random code with code specific to your provider.

Prerequisites

Prerequisites for this repository are already satisfied by the Pulumi Devcontainer if you are using Github Codespaces, or VSCode.

If you are not using VSCode, you will need to ensure the following tools are installed and present in your $PATH:

• pulumictl
• Go or 1.latest
• NodeJS 14.x. We recommend using nvm to manage NodeJS installations.
• Yarn
• TypeScript
• Python (called as python3). For recent versions of MacOS, the system-installed version is fine.
• .NET

Build & test the Adobe Experience Manager provider

1. Create a new Github CodeSpaces environment using this repository.
2. Open a terminal in the CodeSpaces environment.
3. Run make build install to build and install the provider.
4. Run make gen_examples to generate the example programs in examples/ off of the source examples/yaml example program.
5. Run make up to run the example program in examples/yaml.
6. Run make down to tear down the example program.

Build the provider and install the plugin

$ make build install

This will:

1. Create the SDK codegen binary and place it in a ./bin folder (gitignored)
2. Create the provider binary and place it in the ./bin folder (gitignored)
3. Generate the dotnet, Go, Node, and Python SDKs and place them in the ./sdk folder
4. Install the provider on your machine.

Test against the example

$ cd examples/simple
$ yarn link @wttech/aem
$ yarn install
$ pulumi stack init test
$ pulumi up

Now that you have completed all of the above steps, you have a working provider that generates a random string for you.

A brief repository overview

You now have:

1. A provider/ folder containing the building and implementation logic
   1. cmd/pulumi-resource-aem/main.go - holds the provider's sample implementation logic.
2. deployment-templates - a set of files to help you around deployment and publication
3. sdk - holds the generated code libraries created by pulumi-gen-aem/main.go
4. examples a folder of Pulumi programs to try locally and/or use in CI.
5. A Makefile and this README.

Additional Details

This repository depends on the pulumi-go-provider library. For more details on building providers, please check the Pulumi Go Provider docs.

Build Examples

Create an example program using the resources defined in your provider, and place it in the examples/ folder.

You can now repeat the steps for build, install, and test.

Configuring CI and releases

1. Follow the instructions laid out in the deployment templates.

References

Other resources/examples for implementing providers:

• Pulumi Command provider
• Pulumi Go Provider repository