Install the Edge apigee-setup utility

Edge for Private Cloud v. 4.16.05

To install Edge on a node, you first install the Edge apigee-setup utility. If you are in an environment where your nodes do not have an external internet connection, you must also install a local copy of the Apigee repo.

Creating a symlink from /opt/apigee

Edge installs all files in the /opt/apigee directory. You cannot change this directory. However, if desired, you can create a symlink to map /opt/apigee to another location.

Before you create the symlink, you must first create a user and group named "apigee". This is the same group and user created by the Edge installer.

To create the symlink, perform these steps before downloading the bootstrap_4.16.05.sh file. You must perform all of these steps as root:

  1. Create the "apigee" user and group:
    > groupadd -r apigee
    > useradd -r -g apigee -d /opt/apigee -s /sbin/nologin -c "Apigee platform user" apigee
  2. Create a symlink from /opt/apigee to your desired install root:
    > ln -Ts /srv/myInstallDir /opt/apigee
    where /srv/myInstallDir is the desired location of the Edge files.
  3. Change ownership of the install root and symlink to the "apigee" user:
    > chown -h apigee:apigee /srv/myInstallDir /opt/apigee

Prerequisite: Disable SELinux

You must disable SELinux, or set it to permissive mode, before you can install Edge apigee-setup utility or any Edge components. If necessary, after installing Edge, you can re-enable SELinux.

  • To temporarily set SELinux to permissive mode, execute the following command:
    1. On a Linux 6.x operating system:
      echo 0 > /selinux/enforce

      To re-enable SELinux after installing Edge:
      echo 1 > /selinux/enforce
    2. On a Linux 7.x operating system:
      setenforce 0

      To re-enable SELinux after installing Edge:
      setenforce 1
  • To permanently disable SELinux or set it to permissive mode:
    1. Open /etc/sysconfig/selinux in an editor.
    2. Set SELINUX=disabled or SELINUX=permissive
    3. Save your edits.
    4. Restart the node.
    5. If necessary, re-enable SELinux after Edge installation by repeating this procedure to set SELINUX=enabled.

Install Edge apigee-setup utility on a node with an external internet connection

To install Edge on a node with an external Internet connection:

  1. Obtain the username and password from Apigee that you use to access the Apigee repository. If you have an existing username:password for the Apigee ftp site, you can use those credentials.
  2. Log in to your node as root to install the Edge RPMs
    Note: While RPM installation requires root access, you can perform Edge configuration without root access.
  3. Disable SELinux as described above.
  4. Download the Edge bootstrap_4.16.05.sh file to /tmp/bootstrap_4.16.05.sh:
    > curl https://software.apigee.com/bootstrap_4.16.05.sh -o /tmp/bootstrap_4.16.05.sh
  5. Install the Edge apigee-service utility and dependencies:
    > sudo bash /tmp/bootstrap_4.16.05.sh apigeeuser=uName apigeepassword=pWord

    where uName:pWord are the username and password you received from Apigee. If you omit pWord, you will be prompted to enter it.

    By default, the installer checks to see that you have Java 1.8 installed. If you do not, it installs it for you. Use the JAVA_FIX option to specify how to handle Java installation. JAVA_FIX takes the following values:

    I = Install OpenJDK 1.8 (default)
    C = Continue without installing Java
    Q = Quit. For this option, you have to install Java yourself.

    The installation of the apigee-service utility creates the /etc/yum.repos.d/apigee.repo file that defines the Apigee repository. To view the definition file, use the command:
    > cat /etc/yum.repos.d/apigee.repo

    To view the repo contents, use the command:
    > sudo yum -v repolist 'apigee*'
  6. Use apigee-service to install the apigee-setup utility:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
  7. Use apigee-setup to install and configure Edge components on the node. See Install Edge components on a node for more.

Install Edge apigee-setup utility on a node with no external Internet connection

If your Edge nodes are behind a firewall, or in some other way are prohibited from accessing the Apigee repository over the Internet, then you must create a local repository, or mirror, of the Apigee repo. That mirror must then be accessible to all nodes. Once created, nodes can then access that local mirror to install Edge.

Note: Apigee does not host all third-party dependencies in our public repositories. You must download and install these dependencies from publicly accessible repositories.

After you create a local Edge repository, you might later have to update it with the latest Edge release files. The following sections describe how to create a local repository, and how to update it.

Create a local Apigee repository

To create a local Apigee repo:

  1. Obtain the username and password from Apigee that you use to access the Apigee repository. If you have an existing username:password for the Apigee ftp site, you can use those credentials.
  2. Log in to your RedHat or CentOS node as root to install the Edge RPMs.
    Note: While RPM installation requires root access, you can perform Edge configuration without root access.
  3. Make sure you have the latest version of yum-utils:
    > sudo yum update yum-utils
  4. Disable SELinux as described above.
  5. Download the Edge bootstrap_4.16.05.sh file to /tmp/bootstrap_4.16.05.sh:
    > curl https://software.apigee.com/bootstrap_4.16.05.sh -o /tmp/bootstrap_4.16.05.sh
  6. Install the Edge apigee-service utility and dependencies:
    > sudo bash /tmp/bootstrap_4.16.05.sh apigeeuser=uName apigeepassword=pWord

    where uName:pWord are the username and password you received from Apigee. If you omit pWord, you will be prompted to enter it.
  7. Install the apigee-mirror utility on the node:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror install
  8. Use the apigee-mirror utility to sync the Apigee repo to the /opt/apigee/data/apigee-mirror/repos/ directory.

    To minimize the size of the repo, include the --only-new-rpms to download just the latest RPMs. You need approximately 1.6GB of disk space for the download:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror sync --only-new-rpms

    If you want to download the entire repo, including older RPMs, omit --only-new-rpms. You need approximately 6 GB of disk space for the full download:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror sync

    You now have a local copy of the Apigee repo. The next section describes how to install the Edge apigee-setup utility from the local repo.
  9. (Optional) If you want to install Edge from the local repo onto the same node that hosts the local repo, then you need to first run the following commands:
    1. Run bootstrap_4.16.05.sh from the local repo to install the apigee-service utility:
      > sudo bash /opt/apigee/data/apigee-mirror/repos/bootstrap_4.16.05.sh apigeeprotocol="file://" apigeerepobasepath=/opt/apigee/data/apigee-mirror/repos
    2. Use apigee-service to install the apigee-setup utility:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
    3. Use apigee-setup to install and configure Edge components on the node. See Install Edge components on a node for more.

Install apigee-setup on a remote node from the local repo

You have two options for installing Edge from the local repo. You can either:

  • Create a .tar file of the repo, copy the .tar file to a node, and then install Edge from the .tar file.
  • Install a webserver on the node with the local repo so that other nodes can access it. Apigee provides the Nginx webserver for you to use, or you can use your own webserver.

Install from the .tar file:

  1. On the node with the local repo, use the following command to package the local repo into a single .tar file named /opt/apigee/data/apigee-mirror/apigee-4.16.05.tar.gz:

    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror package
  2. Copy the .tar file to the node where you want to install Edge. For example, copy it to the /tmp directory on the new node.
  3. On the new node, disable SELinux as described above.
  4. On the new node, untar the file to the /tmp directory:
    > tar -xzf apigee-4.16.05.tar.gz

    This command creates a new directory, named repos, in the directory containing the .tar file. For example /tmp/repos.
  5. Install the Edge apigee-service utility and dependencies from /tmp/repos:
    > sudo bash /tmp/repos/bootstrap_4.16.05.sh apigeeprotocol="file://" apigeerepobasepath=/tmp/repos

    Notice that you include the path to the repos directory in this command.
  6. Use apigee-service to install the apigee-setup utility:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
  7. Use apigee-setup to install and configure Edge components on the node. See Install Edge components on a node for more.

Install from the repo using the Nginx webserver:

  1. Install the Nginx webserver on the repo node:
    > opt/apigee/apigee-service/bin/apigee-service apigee-mirror nginxconfig
  2. By default, Nginx is configured to use localhost as the server name and port 3939. To change these values
    1. Open /opt/apigee/customer/application/mirror.properties in an editor. Create the file if it does not exist.
    2. Set the following values as necessary:
      conf_apigee_mirror_listen_port=3939
      conf_apigee_mirror_server_name=localhost
    3. Restart Nginx:
      > /opt/nginx/scripts/apigee-nginx restart
  3. By default, the repo requires a username:password of admin:admin. To change these credentials, set the following environment variables:
    MIRROR_USERNAME=uName
    MIRROR_PASSWORD=pWord
  4. On the new node, disable SELinux as described above.
  5. On the remote node, download the Edge bootstrap_4.16.05.sh file to /tmp/bootstrap_4.16.05.sh:
    > /usr/bin/curl http://uName:pWord@remoteRepo:3939/bootstrap_4.16.05.sh -o /tmp/bootstrap_4.16.05.sh

    where uName:pWord are the username and password you set above for the repo, and remoteRepo is the IP address or DNS name of the repo node.
  6. On the remote node, install the Edge apigee-service utility and dependencies:
    > sudo bash /tmp/bootstrap_4.16.05.sh apigeerepohost=remoteRepo:3939 apigeeuser=uName apigeepassword=pWord apigeeprotocol=http://

    where uName:pWord are the repo username and password.
  7. On the remote node, use apigee-service to install the apigee-setup utility:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
  8. Use apigee-setup to install and configure Edge components on the remote node. See Install Edge components on a node for more.

Update a local Apigee repository

To update the repo, you must download the latest bootstrap_4.16.05.sh file, then perform a new sync:

  1. Download the Edge bootstrap_4.16.05.sh file to /tmp/bootstrap_4.16.05.sh:
    > curl https://software.apigee.com/bootstrap_4.16.05.sh -o /tmp/bootstrap_4.16.05.sh
  2. Perform the sync:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror sync --only-new-rpms
  3. If you want to download the entire repo:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror sync

Clean a local Apigee repo

Cleaning the local repo deletes /opt/apigee/data/apigee-mirror and /var/tmp/yum-apigee-*.

To clean the local repo, use:

> /opt/apigee/apigee-service/bin/apigee-service apigee-mirror clean

Add or update Edge 4.16.01 in a 4.16.05 repo

If you have to maintain installations for both Edge 4.16.05 and 4.16.01, you can maintain a repo that contains both versions. From that repo, you can then install either Edge 4.16.05 and 4.16.01.

To add 4.16.01 to an 4.15.05 repo:

  1. Ensure that you have installed the 4.16.05 version of the apigee-mirror utility:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-mirror version

    You should see a result in the form below, where xyz is the build number:
    apigee-mirror-4.16.05-0.0.xyz
  2. Use the apigee-mirror utility to download Edge 4.16.01 to your repo. Notice how you prefix the command with apigeereleasever=4.16.01:
    > apigeereleasever=4.16.01 /opt/apigee/apigee-service/bin/apigee-service apigee-mirror sync --only-new-rpms

    Use this same command to later update the 4.16.01 repo.
  3. Examine the /opt/apigee/data/apigee-mirror/repos directory to see the file structure:
    > ls /opt/apigee/data/apigee-mirror/repos

    You should see the following files and directories:
    apigee apigee-repo-1.0-6.x86_64.rpm bootstrap_4.16.01.sh bootstrap_4.16.05.sh thirdparty

    Notice how you have a bootstrap file for both versions of Edge. The apigee directory also contains separate directories for each version of Edge.
  4. To package the repo into a .tar file, use the following command:
    > apigeereleasever=4.16.01 /opt/apigee/apigee-service/bin/apigee-service apigee-mirror package

    This command packages both the 4.16.05 and 4.16.01 repos into the same .tar file. You cannot package only part of the repo.

To install Edge from the local repo or .tar file, just make sure to run the correct bootstrap file by using one of the following commands:

  • If installing from a .tar file, run the correct bootstrap file from the repo:
    > sudo bash /tmp/repos/bootstrap_4.16.0X.sh apigeeprotocol="file://" apigeerepobasepath=/tmp/repos

    To complete the installation, follow the remaining steps from "Install from the .tar file" above.
  • If installing using the Nginx webserver, download and then run the correct bootstrap file from the repo:
    > /usr/bin/curl http://uName:pWord@remoteRepo:3939/bootstrap_4.16.0X.sh -o /tmp/bootstrap_4.16.0X.sh
    > sudo bash /tmp/bootstrap_4.16.0X.sh apigeerepohost=remoteRepo:3939 apigeeuser=uName apigeepassword=pWord apigeeprotocol=http://

    To complete the installation, follow the remaining steps from "Install from the repo using the Nginx webserver" above.