Apigee OPDK Installation and Maintenance

This repository contains Ansible playbooks that use roles to install, configure and maintain Apigee Edge, Developer Portal and the Monitoring Dashboard. These playbooks orchestrate the usage of the roles to achieve the installation, upgrade and maintenance of the Edge platform. The roles perform functionally discrete activities. This is important because many installation, configuration and maintenance activities are multiple invocations of the same scripts or commands except for changes in either the parameters used, the sequence of the invocations or both. Please see the links below for descriptions and instructions specific to your activity.

General Usage Instructions

Ansible playbooks are invoked at the command line. The assumption is that you know Ansible or are capable of learning Ansible quickly.

Ansible Playbooks

Ansible playbooks are always invoked using ansible-playbook. Please refer to Ansible Documentation for details on installing and running Ansible.

Ansible Tags

These playbooks use Ansible tags extensively to execute functionally significant portions of the installation. These tags have been used consistently across all the playbooks. In some cases, the tags perform slightly different tasks but achieve the semantic functionality ascribed by the name.

Tag NameDescription
cacheUpdates the local Ansible cache with OPDK variables that are used for the generation of configuration files.
osPrepares the operating system for the installation of OPDK as covered here and here. This covers operating system packages and updates to system configuration files.
bootstrapInstall the Apigee bootstrap. This adapts to either online or offline
commonInstall common Apigee components used on all nodes, does not include operating system packages
configGenerate the Edge Configuration File
dsInstall the ds profile
msInstall the ms profile
rmpInstall the rmp profile
rInstall the r profile
mpInstall the mp profile
qpidInstall the qs profile
pgInstall the ps profile
orgOnboard an organization
validateValidate the installation
logsDownload the configuration files and logs on a node that contains an Apigee component

Installing, Updating and Maintaining Apigee Components and Support Servers

Playbook DescriptionPlaybook NamePlaybook Role Requirements
Install AIOinstall-edge-aio.ymlinstall-edge-aio-requirements.yml
Install Edgeinstall-edge.ymlinstall-edge-requirements.yml
Upgrade Edgeupgrade-edge.ymlupgrade-edge-requirements.yml
Install Developer Portalinstall-devportal.ymlinstall-devportal-requirements.yml
Install Baasinstall-baas.ymlinstall-baas-requirements.yml
Install Monitoring Dashboardinstall-monitoring.ymlinstall-monitoring-requirements.yml
Install Apigee Mirrorinstall-mirror.yminstall-mirror-requirements.yml
Install Monetizationinstall-monetization.ymlinstall-monetization-requirements.yml
Add a Data Center to a Planetedge-expansion.ymledge-expansion-requirements.yml
Clean Control Serverclean.ymlNA
Hard Remove of Apigee from a Nodeapigee-node-rollback.ymlNA
Download Apigee Logsapigee-log-config-files.ymlNA
Apigee Bash Scripts Debug Modeapigee-opdk-debug-mode.ymlapigee-opdk-debug-mode-requirements.yml

Not Google Product Clause

This is not an officially supported Google product.