Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shinesolutions/aem-opencloud-manager

A set of Jenkins pipelines for provisioning and managing AEM OpenCloud environments
https://github.com/shinesolutions/aem-opencloud-manager

aem aem-opencloud ci-cd environment-manager jenkins pipeline

Last synced: about 1 month ago
JSON representation

A set of Jenkins pipelines for provisioning and managing AEM OpenCloud environments

Host: GitHub
URL: https://github.com/shinesolutions/aem-opencloud-manager
Owner: shinesolutions
License: apache-2.0
Created: 2018-12-20T00:25:21.000Z (about 6 years ago)
Default Branch: main
Last Pushed: 2024-05-07T06:22:33.000Z (8 months ago)
Last Synced: 2024-05-07T07:31:51.417Z (8 months ago)
Topics: aem, aem-opencloud, ci-cd, environment-manager, jenkins, pipeline
Language: Jinja
Homepage:
Size: 1.03 MB
Stars: 6
Watchers: 9
Forks: 6
Open Issues: 19
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://github.com/shinesolutions/aem-opencloud-manager/workflows/CI/badge.svg)](https://github.com/shinesolutions/aem-opencloud-manager/actions?query=workflow%3ACI)

AEM OpenCloud Manager

---------------------

AEM OpenCloud Manager is a set of [Jenkins](https://jenkins.io/) pipelines for provisioning and managing AEM OpenCloud environments.

These pipelines can be provisioned to a CI/CD system (currently only supports Jenkins) and serves as

Learn more about AEM OpenCloud Manager:

* [Installation](https://github.com/shinesolutions/aem-opencloud-manager#installation)

* [Configuration](https://github.com/shinesolutions/aem-opencloud-manager/blob/main/docs/configuration.md)

* [Usage](https://github.com/shinesolutions/aem-opencloud-manager#usage)

* [Testing](https://github.com/shinesolutions/aem-opencloud-manager#testing)

* [AWS Permissions](https://github.com/shinesolutions/aem-opencloud-manager/blob/main/docs/aws-permissions.md)

* [Customisation Points](https://github.com/shinesolutions/aem-opencloud-manager/blob/main/docs/customisation-points.md)

AEM OpenCloud Manager is part of [AEM OpenCloud](https://aemopencloud.io) platform.

Installation

------------

- Either clone AEM OpenCloud Manager `git clone https://github.com/shinesolutions/aem-opencloud-manager.git` or download one of the [released versions](https://github.com/shinesolutions/aem-opencloud-manager/releases)

- Install the following required tools:

  * [Python](https://www.python.org/downloads/) version 2.7.x

  * [GNU Make](https://www.gnu.org/software/make/)


  Alternatively, you can use [AEM Platform BuildEnv](https://github.com/shinesolutions/aem-platform-buildenv) Docker container to run AEM OpenCloud Manager build targets.

- Resolve the [Python packages](https://github.com/shinesolutions/aem-opencloud-manager/blob/main/requirements.txt) dependencies by running `make deps`

- Provision required plugins onto Jenkins instance: `make jenkins-init config_path=`, which installs the following plugins:

  * [Pipeline Utility Steps plugin](https://plugins.jenkins.io/pipeline-utility-steps)

- Approve the following script signatures, unfortunately you currently have to approve these methods manually one by one via prompts on Jenkins log output.

  * `method java.net.URI getHost`

  * `method java.net.URI getPath`

  * `method java.net.URI getScheme`

  * `new java.net.URI java.lang.String`

  * `staticMethod org.codehaus.groovy.runtime.DefaultGroovyMethods drop java.lang.Object[] int`

  * `staticMethod org.codehaus.groovy.runtime.DefaultGroovyMethods init java.lang.Object[]`

Usage

-----

- Set up the required [AWS Permissions](https://github.com/shinesolutions/aem-opencloud-manager/blob/main/docs/aws-permissions.md)

- Create [configuration file](https://github.com/shinesolutions/aem-opencloud-manager/blob/main/docs/configuration.md)

- Generate and provision the pipelines onto a Jenkins instance: `make jenkins-aws config_path=`

- Visit your Jenkins instance and you should find a new folder named `aem-opencloud-`

Build categories

----------------

| Category | Description |

|----------|-------------|

| installation | Install AEM OpenCloud libraries ([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), [AEM Test Suite](https://github.com/shinesolutions/aem-test-suite)) followed by the AEM AWS Stack Builder dependency libraries. |

| machine-images | Create machine images containing AEM installations and utilities. |

| manage-environments | Create and delete AEM Stack Manager, AEM Consolidated, and AEM Full-Set environments. |

| operational-tasks | Run AEM operational tasks such as deploying AEM packages, taking backups, flushing cache, promoting AEM Author Standby to become Primary, and many others. |

| testing | Run various tests against AEM environments. |

Testing

-------

### Testing with remote dependencies

You can run integration test for generating and provisioning Jenkins pipelines using the command `make test-integration cicd_type=jenkins platform_type=aws`, which downloads the dependencies from the Internet.

### Testing with local dependencies

If you're working on the dependencies of AEM OpenCloud Manager and would like to test them as part of pipelines generation and provisioning, you need to:

- Clone the dependency repos [AEM Hello World Config](https://github.com/shinesolutions/aem-helloworld-config) at the same directory level as AEM OpenCloud Manager

- Make your code changes against those dependency repos

- Run `make test-integration-local cicd_type=jenkins platform_type=aws` for integration testing using local dependencies, which copies those local dependency repos to AEM OpenCloud Manager and use them as part of the test