https://github.com/shinesolutions/aem-helloworld-config
Example AEM Hello World configuration
https://github.com/shinesolutions/aem-helloworld-config
aem aem-opencloud config example
Last synced: about 1 year ago
JSON representation
Example AEM Hello World configuration
- Host: GitHub
- URL: https://github.com/shinesolutions/aem-helloworld-config
- Owner: shinesolutions
- License: apache-2.0
- Created: 2018-12-05T22:13:02.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T05:37:19.000Z (almost 2 years ago)
- Last Synced: 2025-01-16T08:28:33.213Z (about 1 year ago)
- Topics: aem, aem-opencloud, config, example
- Language: Makefile
- Homepage:
- Size: 887 KB
- Stars: 2
- Watchers: 8
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/shinesolutions/aem-helloworld-config/actions?query=workflow%3ACI)
AEM Hello World Config
----------------------
AEM Hello World Config is an example configuration for [Packer AEM](https://github.com/shinesolutions/packer-aem), [AEM AWS Stack Builder](https://github.com/shinesolutions/aem-aws-stack-builder), [AEM Stack Manager Messenger](https://github.com/shinesolutions/aem-stack-manager-messenger), and [AEM Test Suite](https://github.com/shinesolutions/aem-test-suite). These configuration files are consumed by those repos via `deps-test` or `deps-test-local` Makefile targets.
AEM Hello World Config is part of [AEM OpenCloud](https://aemopencloud.io) platform.
Usage
-----
To generate Packer AEM configurations:
make gen-packer-aem
The configuration files will be generated at `packer-aem/--/` .
The permutation of Packer AEM configurations are generated from the source `packer-aem/src/` .
To generate AEM AWS Stack Builder configurations:
make gen-aem-aws-stack-builder
The configuration files will be generated at `aem-aws-stack-builder/-/` .
The permutation of AEM AWS Stack Builder configurations are generated from the source `aem-aws-stack-builder/src/` .
To update the AMI IDs with the latest AMIs:
make gen-aem-aws-stack-builder-ami-ids
This will update the `aem-aws-stack-builder/src/apps/aem/*-stack-builder-ami-ids.yaml` files with the latest AMI IDs for the configured OSes and AEM versions.
Local configuration
-------------------
If you want to specify a local configuration that wouldn't be pushed to origin, you can create a file named `zzz-local.yaml` and place it on any configuration path. Some use cases for local configuration is for creating an AEM environment with your own EC2 keypair, or for creating an AEM environment with your own AMI IDs.
For example, if you want to create an AEM consolidated environment with RHEL7 and AEM 6.4 and you want to be able to SSH into the EC2 instances. Create the file `aem-aws-stack-builder/aem-consolidated-rhel7-aem64/zzz-local.yaml` with content:
---
compute:
key_pair_name:
If you want to use your own AMI IDs:
---
ami_ids:
author:
author_dispatcher:
author_publish_dispatcher:
chaos_monkey:
orchestrator:
publish:
publish_dispatcher:
Naming convention
-----------------
| Directory | Description |
|-----------|-------------|
| `packer-aem/` | Contains [Packer AEM configurations](https://github.com/shinesolutions/packer-aem/blob/master/docs/configuration.md). [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/packer-aem/src) |
| `packer-aem/src/` | Contains common Packer AEM YAML configuration files. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/packer-aem/src) |
| `packer-aem/aws-resources-/` | Contains YAML configuration files for a given Packer AEM AWS resources profile. The directory should be named with `aws-resources-` prefix, e.g. `aws-resources-sandpit`. This directory should contain files copied from `packer-aem/src/` which are relevant for AWS resources profile. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/packer-aem/aws-resources-sandpit) |
| `packer-aem/-/` | Contains YAML configuration files for a given Packer AEM profile for platform type (e.g. `aws`). The directory should be named with `aws-` prefix, e.g. `aws-rhel7-aem64`, `aws-amazon-linux2-aem64`. This directory should contain files copied from `packer-aem/src/` which are relevant for the profile. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/packer-aem/aws-rhel7-aem64) |
| `aem-aws-stack-builder/` | Contains [AEM AWS Stack Builder configurations](https://github.com/shinesolutions/aem-aws-stack-builder/blob/master/docs/configuration.md). [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-aws-stack-builder) |
| `aem-aws-stack-builder/src/` | Contains common AEM AWS Stack Builder configuration files. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-aws-stack-builder/src) |
| `aem-aws-stack-builder/aem-full-set-/` | Contains YAML configuration files for a given AEM Full-Set profile. The directory should be named with `aem-full-set-` prefix, e.g. `aem-full-set-rhel7-aem64-dev`, `aem-full-set-amazon-linux2-aem64-prod`. This directory should contain files copied from `aem-aws-stack-builder/src/` which are relevant for the profile. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-aws-stack-builder/aem-full-set-rhel7-aem64) |
| `aem-aws-stack-builder/aem-consolidated-/` | Contains YAML configuration files for a given AEM Consolidated profile. The directory should be named with `aem-consolidated-` prefix, e.g. `aem-consolidated-rhel7-aem64-dev`, `aem-consolidated-amazon-linux2-aem64-prod`. This directory should contain files copied from `aem-aws-stack-builder/src/` which are relevant for the profile. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-aws-stack-builder/aem-consolidated-rhel7-aem64) |
| `aem-aws-stack-builder/aem-stack-manager-/` | Contains YAML configuration files for a given AEM Stack Manager profile. The directory should be named with `aem-stack-manager-` prefix, e.g. `aem-stack-manager-dev`, `aem-stack-manager-prod`. This directory should contain files copied from `aem-aws-stack-builder/src/` which are relevant for the profile. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-aws-stack-builder/aem-stack-manager-sandpit) |
| `aem-stack-manager-messenger/` | Contains [AEM Stack Manager Messenger configurations](https://github.com/shinesolutions/aem-stack-manager-messenger/blob/master/docs/configuration.md). [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-stack-manager-messenger) |
| `aem-stack-manager-messenger/` | Contains YAML configuration files for a given AEM Stack Manager profile. A profile could be named anything descriptive, e.g. `sandpit`, `prod`. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-stack-manager-messenger/sandpit) |
| `aem-test-suite/` | Contains [AEM Test Suite configurations](https://github.com/shinesolutions/aem-test-suite/blob/master/docs/configuration.md). [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-test-suite) |
| `aem-test-suite/` | Contains YAML configuration files for a given AEM Test Suite profile. A profile could be named anything descriptive, e.g. `sandpit`, `dev`, `test`, `prod`. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-test-suite/sandpit) |
| `aem-opencloud-manager/` | Contains [AEM OpenCloud Manager configurations](https://github.com/shinesolutions/aem-opencloud-manager/blob/master/docs/configuration.md). [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-opencloud-manager/) |
| `aem-opencloud-manager/` | Contains YAML configuration files for a given AEM OpenCloud Manager profile. A profile could be named anything descriptive, e.g. `sandpit`, `dev`, `test`, `prod`. [Example](https://github.com/shinesolutions/aem-helloworld-config/tree/master/aem-opencloud-manager/sandpit) |
The directories under `aem-aws-stack-builder` must be prefixed with either one of `aem-consolidated-`, `aem-full-set-`, or `aem-stack-manager-`.
The prefix will then be used to identify the profiles drop down list on [AEM OpenCloud Manager](https://github.com/shinesolutions/aem-opencloud-manager) . Please note that this feature is not yet completed as AEM OpenCloud Manager is still being developed.