Updated existing changes
1 file changed
tree: b9f1fde9e533b602f1156051dda0c0cbe26998ee
  1. .gitignore
  2. apigee-analysis.yml
  3. apigee-baas-configuration.yml
  4. apigee-edge-configuration.yml
  5. apigee-log-config-files.yml
  6. apigee-node-rollback-remove-cassandra.yml
  7. apigee-node-rollback-remove-mp.yml
  8. apigee-node-rollback-remove-qpid.yml
  9. apigee-node-rollback-remove-router.yml
  10. apigee-node-rollback.yml
  11. apigee-opdk-debug-mode-requirements.yml
  12. apigee-opdk-debug-mode.yml
  13. apigee-opdk-validate-component-ports.yml
  14. apigee-openldap.yml
  15. apigee-os-pre-requisites-devportal.yml
  16. apigee-os-pre-requisites-epel.yml
  17. apigee-os-pre-requisites-openldap.yml
  18. apigee-os-pre-requisites-pip.yml
  19. apigee-os-pre-requisites-postgres.yml
  20. apigee-os-pre-requisites.yml
  21. apigee-planet-cache.yml
  22. apigee-pre-requisites-bootstrap.yml
  23. apigee-pre-requisites-common-install.yml
  24. apigee-pre-requisites-common-update.yml
  25. clean.yml
  26. edge-expansion-rebuild-cassandra.yml
  27. edge-expansion-register-qpid.yml
  28. edge-expansion.yml
  29. edge-pgmaster-pgstandby-node-config.yml
  30. install-baas-requirements.yml
  31. install-baas-setup-org.yml
  32. install-baas.yml
  33. install-devportal-postgres-component-setup.yml
  34. install-devportal-requirements.yml
  35. install-devportal-ui-component-setup.yml
  36. install-devportal.yml
  37. install-edge-aio-requirements.yml
  38. install-edge-aio.yml
  39. install-edge-cassandra-client.yml
  40. install-edge-cassandra-zookeeper-component-setup.yml
  41. install-edge-management-server-component-setup.yml
  42. install-edge-message-processor-component-setup.yml
  43. install-edge-monetization-component-provisioning.yml
  44. install-edge-monetization-component-setup.yml
  45. install-edge-monetization-mgmt-cluster.yml
  46. install-edge-pg-component-setup.yml
  47. install-edge-planet-two_regions.yml
  48. install-edge-qpid-component-setup.yml
  49. install-edge-region-single-edge.yml
  50. install-edge-region-validate-port-connectivity.yml
  51. install-edge-requirements.yml
  52. install-edge-rmp-component-setup.yml
  53. install-edge-rmp-validate.yml
  54. install-edge-router-component-setup.yml
  55. install-edge-setup-org.yml
  56. install-edge-sso-requirements.yml
  57. install-edge-sso.yml
  58. install-edge.yml
  59. install-mirror-requirements.yml
  60. install-mirror.yml
  61. install-monetization-requirements.yml
  62. install-monetization.yml
  63. install-monitoring-grafana-component-setup.yml
  64. install-monitoring-influxdb-component-setup.yml
  65. install-monitoring-requirements.yml
  66. install-monitoring-telegraf-component-setup.yml
  67. install-monitoring.yml
  68. install-profile-component-setup.yml
  69. LICENSE
  70. lvm-requirements.yml
  71. lvm.yml
  72. post-install-edge-setup-org.yml
  73. post-install-message-processor-binding.yml
  74. post-install-org-env-iteration.yml
  75. README-apigee-opdk-debug-mode.md
  76. README-install-devportal.md
  77. README-install-edge-aio.md
  78. README-install-edge.md
  79. README-install-monitoring.md
  80. README-upgrade-edge.md
  81. README.md
  82. remove-backup-files.yml
  83. update-cache-value.yml
  84. update-sudoers.yml
  85. upgrade-edge-planet.yml
  86. upgrade-edge-postgres-fix-pg_control-file.yml
  87. upgrade-edge-postgres.yml
  88. upgrade-edge-requirements.yml
  89. upgrade-edge-rollback.yml
  90. upgrade-edge.yml
README.md

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.

Playbook Usage

Usage involves the following steps:

  1. Configure Ansible so that the location of configurations, inventories, logs, cache and roles is known and accessible.
  2. Use ansible-galaxy to download roles
  3. Use an inventory template to configure your actual inventory.
  4. Use ansible-playbook to execute the tasks.

Configuring Ansible

An Apigee OPDK Ansible Configuration Accelerator is available to get you going quickly. Please refer to the accelerator to understand how to configure the following:

  • Setup Ansible configuration files to indicate
  • Inventory of servers
  • SSH access
  • Assignment of OPDK roles to servers
  • Configuration of custom-properties.yml
  • Configuration of credentials.yml
  • Location of your license.txt

Installing Ansible

Please refer to Ansible Documentation for details on installing, configuring and running Ansible.

Ansible Galaxy

We are using Ansible Galaxy to distribute playbook role dependencies. The basic usage pattern we follow is:

ansible-galaxy install -r { galaxy-formatted-requirements-file.yml } -f

A table has been provided that maps Ansible Galaxy dependency files to Ansible Playbooks.

Ansible Playbooks

Ansible playbooks are invoked at the command line as:

 ansible-playbook { playbook-file.yml }

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 in the Edge Installation Overview and Install the Edge Apigee Setup Utility. This covers operating system packages, updates to system configuration files and adapts to operating systems.
bootstrapInstall the Apigee bootstrap. This adapts to either online or offline
commonInstall common Apigee components used on all nodes. This 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

Installation, Configuration and Maintenance Scripts

Playbook Description (README's Available)Playbook 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
Apigee Bash Scripts Debug Modeapigee-opdk-debug-mode.ymlapigee-opdk-debug-mode-requirements.yml
Install Developer Portalinstall-devportal.ymlinstall-devportal-requirements.yml
Install Monitoring Dashboardinstall-monitoring.ymlinstall-monitoring-requirements.yml

Installation, Configuration and Maintenance Scripts (Under Construction)

Playbook Description (README's under construction)Playbook NamePlaybook Role Requirements
Install Baasinstall-baas.ymlinstall-baas-requirements.yml
Install Apigee Mirrorinstall-mirror.ymlinstall-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

Not Google Product Clause

This is not an officially supported Google product.

How to Contribute

We'd love to accept your patches and contributions to this project. Please review our guidelines.