| commit | 3b6eef78e96b67906f900c3e7f4a66f7282da58f | [log] [tgz] |
|---|---|---|
| author | Carlos Frias <friasc@google.com> | Thu Mar 29 14:07:56 2018 -0400 |
| committer | Carlos Frias <friasc@google.com> | Thu Mar 29 14:07:56 2018 -0400 |
| tree | ebef0637a6450e6b46cb3c69b231feb8d92341e6 | |
| parent | cf71c3d940b7f26803273bb98aa2fb6280eb5e2d [diff] |
Updated docs
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.
Ansible playbooks are invoked at the command line. The assumption is that you know Ansible or are capable of learning Ansible quickly.
Ansible playbooks are always invoked using ansible-playbook. Please refer to Ansible Documentation for details on installing and running Ansible.
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 Name | Description |
|---|---|
| cache | Updates the local Ansible cache with OPDK variables that are used for the generation of configuration files. |
| os | Prepares 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 and updates to system configuration files. |
| bootstrap | Install the Apigee bootstrap. This adapts to either online or offline |
| common | Install common Apigee components used on all nodes. This does not include operating system packages |
| config | Generate the Edge Configuration File |
| ds | Install the ds profile |
| ms | Install the ms profile |
| rmp | Install the rmp profile |
| r | Install the r profile |
| mp | Install the mp profile |
| qpid | Install the qs profile |
| pg | Install the ps profile |
| org | Onboard an organization |
| validate | Validate the installation |
| logs | Download the configuration files and logs on a node that contains an Apigee component |
| Playbook Description (README's Available) | Playbook Name | Playbook Role Requirements |
|---|---|---|
| Install AIO | install-edge-aio.yml | install-edge-aio-requirements.yml |
| Install Edge | install-edge.yml | install-edge-requirements.yml |
| Upgrade Edge | upgrade-edge.yml | upgrade-edge-requirements.yml |
| Apigee Bash Scripts Debug Mode | apigee-opdk-debug-mode.yml | apigee-opdk-debug-mode-requirements.yml |
This is not an officially supported Google product.