This repository contains a set of Ansible roles and playbooks to manage the installation, configuration and maintenance of Private Cloud across multiple environments. These playbooks will ensure that Apigee requirements are met regarding the configuration of the operating system, the bootstrap configuration and the installation of components. The operating system prerequisites are managed with the option to defer management of specific items. The bootstrap configuration is managed whether you do an online installation or exercise one of the two offline installation options. Component installation is managed so that all configuration files are generated to the topology indicated and role of the individual node. These playbooks create a central location from where to manage Private Cloud installations.
The Ansible playbooks in this repository support a wide range of the installation, configuration and maintenance use cases that are necessary to successfully manage Apigee Private Cloud Planets. We describe the uses cases that are supported as follows:
| Feature Name | Feature Description |
|---|---|
| Planet Installation | A Private Cloud installation of a Planet containing any number of nodes that follow our recommended HA topologies. |
| Planet Expansion | A Private Cloud Planet can be expanded to either increase the size of the Cassandra Ring, increase transaction capacity with additional Routers and Message Processors or expand the Planet with up to 9 additional regions. |
| Disaster Recovery | These playbooks enable automated disaster recovery scenarios. These playbooks currently operate on Apigee components to remove, re-install, re-configured, scale up or scale down a Planet thereby providing the necessary functionality to drastically reduce the time to recover from a disaster. |
| Planet Maintenance | These playbooks are constructed by composing functionality into Ansible modules called roles to achieve specific use cases. This approach has enabled this framework to re-use the roles that are combined in new ways to provide automation support to the maintenance activities that the Apigee platform requires. |
| Planet Upgrade | The playbooks included in this repository will perform Apigee platform upgrades. |
- This repository assumes that no Apigee Operating System requirements have been fulfilled except to select the basic operating system that is supported.
- A control server is available from which Ansible scripts and modules can be downloaded.
- We assume that you have an introductory understanding of Ansible and Ansible Galaxy.
- Availability of administrative privilege escalation on the control server and the target nodes.
- Ansible version 2.7.7.
The use of this framework is composed of the following steps:
-
Install git, rsync, tree and pip. Assuming you are
sudo yum install -y git, rsync, tree, python-pip sudo pip install ansible google-auth
-
Clone this repository to
~/apigee-opdk-accelerator.git clone git@github.com:apigee/ansible-opdk-accelerator.git ~/apigee-opdk-accelerator
-
Setup an Ansible control server and workspace.
-
Configure Ansible and the Ansible inventory.
-
Please update credentials and license.
-
Please review and update the runtime attributes as needed. Update common installation attributes like
opdk_versionthat is stored in~/.apigee/custom-properties.yml. -
Use
ansible-playbookto carry out an activity from either the installations, infrastructure or post-installation folders.
We'd love to accept your patches and contributions to this project. Please review our guidelines.
This is not an officially supported Google product.