Présentation de l'installation d'un périphérique

Edge for Private Cloud v4.18.05

Une installation Edge typique se compose de composants Edge répartis sur plusieurs nœuds. Après avoir installé Edge sur un nœud, vous installez et configurez un ou plusieurs composants Edge sur le nœud.

Procédure d'installation

L'installation d'Edge sur un nœud est un processus en plusieurs étapes:

  1. Désactivez SELinux sur le nœud ou définissez-le en mode permissif. Pour en savoir plus, consultez la section Installer l'utilitaire de configuration d'Edge apigee-setup.
  2. Décidez si vous souhaitez activer l'authentification Cassandra.
  3. Décidez si vous souhaitez configurer la réplication en attente maître pour Postgres.
  4. Sélectionnez votre configuration Edge dans la liste des topologies recommandées. Par exemple, vous pouvez installer Edge sur un seul nœud pour les tests ou sur 13 nœuds pour la production. Pour en savoir plus, consultez la section Topologies d'installation.
  5. Sur chaque nœud de la topologie sélectionnée, installez l'utilitaire Edge apigee-setup :
    • Téléchargez le fichier Edge bootstrap_4.18.05.sh sur /tmp/bootstrap_4.18.05.sh.
    • Installez l'utilitaire et les dépendances Edge apigee-service.
    • Installez l'utilitaire et les dépendances Edge apigee-setup.

      Pour plus d'informations, reportez-vous à la section Installer l'utilitaire de configuration d'Apigee Edge.

  6. Utilisez l'utilitaire apigee-setup pour installer un ou plusieurs composants Edge sur chaque nœud en fonction de la topologie sélectionnée.

    Consultez la page Installer des composants Edge sur un nœud.

  7. Sur le nœud du serveur de gestion, utilisez l'utilitaire "apigee-setup" pour installer les utilitaires que vous utilisez pour créer et gérer des organisations Edge.

    Pour en savoir plus, consultez Intégrer une organisation.

  8. Redémarrez le composant d'interface utilisateur Edge une fois l'installation terminée.

Qui peut effectuer l'installation ?

Les fichiers de distribution Apigee Edge sont installés sous la forme d'un ensemble de RPM et de dépendances. Pour installer, désinstaller et mettre à jour les RPM Edge, les commandes doivent être exécutées par l'utilisateur racine ou par un utilisateur disposant d'un accès complet sudo. Pour un accès sudo complet, cela signifie que l'utilisateur dispose d'un accès sudo pour effectuer les mêmes opérations qu'avec root.

Tout utilisateur qui souhaite exécuter les commandes ou les scripts suivants doit être root ou disposer d'un accès sudo complet:

  • apigee-service :
    • Commandes apigee-service: install, uninstall, update.
    • Commandes apigee-all: install, uninstall, update.
  • setup.sh pour installer les composants Edge (sauf si vous avez déjà utilisé apigee-service install pour installer les RPM requis). Ensuite, un accès racine ou complet à sudo si cela n'est pas nécessaire.)
  • update.sh pour mettre à jour les composants Edge

En outre, le programme d'installation Edge crée un nouvel utilisateur sur votre système, nommé "apigee". De nombreuses commandes Edge invoquent sudo pour s'exécuter en tant qu'utilisateur "apigee".

Tout utilisateur qui souhaite exécuter toutes les commandes autres que celles indiquées ci-dessus doit être un utilisateur disposant d'un accès sudo complet à l'utilisateur "apigee". Ces commandes incluent:

  • Les commandes utilitaires apigee-service, y compris :
    • commandes apigee-service telles que start, stop, restart, configure.
    • les commandes apigee-all telles que start, stop, restart, configure.

Créer un utilisateur avec un accès sudo complet à l'utilisateur "apigee"

Pour configurer un utilisateur afin qu'il ait un accès sudo complet à l'utilisateur "apigee", utilisez la commande "visudo" pour modifier le fichier sudoers à ajouter:

installUser        ALL=(apigee)      NOPASSWD: ALL

installUser est le nom d'utilisateur de la personne qui travaille avec Edge.

Définir des autorisations sur les fichiers de configuration

Tous les fichiers ou ressources utilisés par les commandes Edge doivent être accessibles à l'utilisateur « apigee ». Cela inclut le fichier de licence Edge et tous les fichiers de configuration.

Lors de la création d'un fichier de configuration, vous pouvez remplacer son propriétaire par "apigee:apigee" pour vous assurer qu'il est accessible aux commandes Edge:

  1. Créez le fichier dans un éditeur comme n'importe quel utilisateur.
  2. chown le propriétaire du fichier par "apigee:apigee" ou, si vous avez changé l'utilisateur exécutant le service Edge au lieu de l'utilisateur "apigee", lancer la commande chown du fichier à l'utilisateur qui exécute le service Edge.

Séparer les tâches d'installation Edge entre l'utilisateur racine et l'utilisateur non racine

Bien qu'il soit plus simple d'effectuer l'intégralité du processus d'installation d'Edge en tant qu'utilisateur racine ou par un utilisateur disposant d'un accès sudo complet, ce n'est pas toujours possible. À la place, vous pouvez séparer le processus en tâches effectuées par root et en tâches effectuées par un utilisateur disposant d'un accès sudo complet à l'utilisateur "apigee".

  1. Tâches effectuées par l'utilisateur root :
    1. Téléchargez et exécutez le fichier bootstrap_4.18.05.sh :
      curl https://software.apigee.com/bootstrap_4.18.05.sh -o /tmp/bootstrap_4.18.05.sh
      sudo bash /tmp/bootstrap_4.18.05.sh apigeeuser=uName apigeepassword=pWord

      Cette étape installe l'utilitaire apigee-service et crée l'utilisateur "apigee".

    2. Configurez un utilisateur pour qu'il dispose d'un accès sudo complet à l'utilisateur "apigee" comme décrit dans la section Créer un utilisateur avec accès sudo complet à l'utilisateur "apigee".
    3. Installez l'utilitaire apigee-setup :
      /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
    4. Utilisez l'utilitaire apigee-setup pour installer les RPM Edge sur le nœud :
      /opt/apigee/apigee-service/bin/apigee-service compName install

      Les RPM en périphérie que vous installez sur le nœud dépendent de votre topologie. La liste des composants disponibles inclut: apigee-provision, apigee-validate, apigee-zookeeper, apigee-cassandra, apigee-openldap, edge-management-server, edge-ui, edge-router, edge-message-processor, apigee-postgresql, apigee-qpidd, edge-postgres-server, edge-qpid-server.

  2. Une fois que l'utilisateur racine a installé les RPM Edge sur le nœud, l'utilisateur disposant d'un accès sudo complet à l'utilisateur "apigee" termine le processus de configuration :
    1. Utilisez l'utilitaire setup.sh pour terminer la configuration des composants Edge sur le nœud. La forme de la commande dépend des composants que vous avez installés sur le nœud. Pour obtenir la liste complète, consultez la page Installer des composants Edge sur un nœud.

      Par exemple, pour terminer l'installation de ZooKeeper et Cassandra, exécutez la commande suivante:

      /opt/apigee/apigee-setup/bin/setup.sh -p ds -f configFile

      configFile correspond au fichier de configuration Edge.

      Pour effectuer une installation tout-en-un, utilisez la commande suivante:

      /opt/apigee/apigee-setup/bin/setup.sh -p aio -f configFile

Emplacement des fichiers de configuration d'installation

Vous devez transmettre à l'utilitaire apigee-setup un fichier de configuration contenant les informations sur l'installation Edge. La seule condition requise pour les installations silencieuses est que le fichier de configuration soit accessible ou lisible par l'utilisateur "apigee". Par exemple, placez le fichier dans le répertoire /usr/local/var ou /usr/local/share sur le nœud et chown dans "apigee:apigee".

Toutes les informations du fichier de configuration sont requises, à l'exception du mot de passe de l'administrateur système Edge. Si vous omettez le mot de passe, l'utilitaire apigee-setup vous invite à le saisir sur la ligne de commande.

Pour en savoir plus, consultez la section Installer des composants Edge sur un nœud.

Gérer un échec d'installation

En cas d'échec lors de l'installation d'un composant Edge, vous pouvez essayer de corriger le problème, puis exécuter à nouveau le programme d'installation. Le programme d'installation est conçu pour être exécuté de manière répétée lorsqu'il détecte une défaillance, ou si vous souhaitez modifier ou mettre à jour un composant après l'installation.

Après l'installation ou la mise à niveau, veillez à redémarrer le composant d'interface utilisateur Edge sur chaque nœud où il s'exécute.

Installation Internet ou non Internet

Pour installer Edge sur un nœud, celui-ci doit pouvoir accéder au dépôt Apigee:

  • Nœuds avec une connexion Internet externe

    Les nœuds avec une connexion Internet externe accèdent au dépôt Apigee pour installer les RPM et les dépendances Edge.

  • Nœuds sans connexion Internet externe

    Les nœuds sans connexion Internet externe peuvent accéder à une version mise en miroir du dépôt Apigee que vous avez configuré en interne. Ce dépôt contient tous les RPM Edge, mais vous devez vous assurer que toutes les autres dépendances sont disponibles à partir des dépôts du réseau interne.

    Pour créer le dépôt Apigee interne, vous avez besoin d'un nœud avec un accès Internet externe pour pouvoir télécharger les RPM et les dépendances Edge. Une fois le dépôt interne créé, vous pouvez le déplacer vers un autre nœud ou rendre ce nœud accessible aux nœuds périphériques pour l'installation.

Utiliser un dépôt Edge local pour maintenir votre version Edge

L'une des raisons d'utiliser un dépôt local, ou en miroir, consiste à installer Edge sur les nœuds sans connexion Internet externe, comme décrit dans la section précédente.

Résoudre les dépendances d'installation RPM

Les fichiers de distribution Apigee Edge sont installés sous la forme d'un ensemble de fichiers RPM, chacun pouvant avoir sa propre chaîne de dépendances d'installation. La plupart de ces dépendances sont définies par des composants tiers qui ne dépendent pas d'Apigee et peuvent être modifiées à tout moment. Par conséquent, la documentation ne répertorie pas le numéro de version explicite de chaque dépendance.

Si vous effectuez une installation sur une machine disposant d'un accès à Internet, le nœud peut télécharger les RPM et les dépendances nécessaires. Toutefois, si vous effectuez l'installation à partir d'un nœud sans accès à Internet, vous configurez généralement un dépôt interne contenant toutes les dépendances nécessaires. Le seul moyen de vous assurer que toutes les dépendances sont incluses dans votre dépôt local consiste à tenter une installation, à identifier les dépendances manquantes et à les copier dans le dépôt local jusqu'à ce que l'installation aboutisse.

Commandes Yum courantes

Les outils d'installation Edge pour Linux s'appuient sur Yum pour installer et mettre à jour les composants. Vous devrez peut-être utiliser plusieurs commandes Yum pour gérer une installation sur un nœud.

  • Nettoyez tous les caches Yum :
    sudo yum clean all
  • Pour mettre à jour un composant Edge :
    sudo yum update componentName

    Exemple :

    sudo yum update apigee-setup
    sudo yum update edge-management-server

Structure de systèmes de fichiers

Edge installe tous les fichiers du répertoire /opt/apigee.

Dans ce guide et dans le guide d'utilisation Edge, le répertoire d'installation racine est indiqué comme suit:

/opt/apigee

L'installation utilise la structure de système de fichiers suivante pour déployer Apigee Edge pour le cloud privé.

Fichiers journaux

Le fichier journal de apigee-setup et le script setup.sh sont écrits dans /tmp/setup-root.log.

Les fichiers journaux de chaque composant se trouvent dans le répertoire /opt/apigee/var/log. Chaque composant possède son propre sous-répertoire. Par exemple, les journaux du serveur de gestion se trouvent dans le répertoire:

/opt/apigee/var/log/edge-management-server

Les tableaux suivants indiquent l'emplacement des fichiers journaux:

Composant Emplacement

Serveur de gestion

/opt/apigee/var/log/edge-management-server

Routeur

/opt/apigee/var/log/edge-router

Edge Router est mis en œuvre à l'aide de Nginx. Pour obtenir des journaux supplémentaires, consultez les pages suivantes:

/opt/apigee/var/log/edge-router/nginx
/opt/nginx/logs

Processeur de messages

/opt/apigee/var/log/edge-message-processor

Serveur Apigee Qpid

/opt/apigee/var/log/edge-qpid-server
Serveur Apigee Postgres /opt/apigee/var/log/edge-postgres-server
Interface utilisateur périphérique /opt/apigee/var/log/edge-ui
ZooKeeper /opt/apigee/var/log/apigee-zookeeper
OpenLDAP /opt/apigee/var/log/apigee-openldap
Cassandra /opt/apigee/var/log/apigee-cassandra
QPIDd /opt/apigee/var/log/apigee-qpidd
Base de données PostgreSQL /opt/apigee/var/log/apigee-postgresql

Données

Composant Emplacement
Serveur de gestion /opt/apigee/data/edge-management-server
Routeur /opt/apigee/data/edge-router
Processeur de messages /opt/apigee/data/edge-message-processor
Agent Apigee Qpid /opt/apigee/data/edge-qpid-server
Agent Apigee Postgres /opt/apigee/data/edge-postgres-server
ZooKeeper /opt/apigee/data/apigee-zookeeper
OpenLDAP /opt/apigee/data/apigee-openldap
Cassandra /opt/apigee/data/apigee-cassandra/data
QPIDd /opt/apigee/data/apigee-qpid/data
Base de données PostgreSQL /opt/apigee/data/apigee-postgres/pgdata

Tâches post-installation

Une fois l'installation terminée, vous pouvez effectuer des actions supplémentaires sur les composants Edge.

Redémarrer le composant d'interface utilisateur Edge

Une fois l'installation terminée, vous devez redémarrer le composant UI Edge sur chaque nœud:

/opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Configurer les composants Edge après l'installation

Pour configurer Edge après l'installation, vous utilisez une combinaison de fichiers .properties et d'utilitaires Edge. Par exemple, pour configurer TLS/SSL sur l'interface utilisateur Edge, vous devez modifier les fichiers .properties pour définir les propriétés nécessaires. Les modifications apportées aux fichiers .properties nécessitent que vous redémarriez le composant Edge concerné.

Les fichiers .properties se trouvent dans le répertoire /opt/apigee/customer/application. Chaque composant possède son propre fichier .properties dans ce répertoire. Exemples : router.properties et management-server.properties.

Pour définir une propriété pour un composant, modifiez le fichier .properties correspondant, puis redémarrez le composant:

/opt/apigee/apigee-service/bin/apigee-service component restart

Exemple :

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

Lorsque vous mettez à jour Edge, les fichiers .properties du répertoire /opt/apigee/customer/application sont lus. Cela signifie qu'elle conserve toutes les propriétés que vous avez définies sur le composant.

Consultez la section Comment configurer Edge pour plus d'informations sur la configuration Edge.

Appeler des commandes sur des composants Edge

Edge installe des utilitaires de gestion sous /opt/apigee/apigee-service/bin que vous pouvez utiliser pour gérer une installation Edge. Par exemple, vous pouvez utiliser l'utilitaire apigee-all pour démarrer, arrêter, redémarrer ou déterminer l'état de tous les composants Edge du nœud:

/opt/apigee/apigee-service/bin/apigee-all stop|start|restart|status|version

Utilisez l'utilitaire apigee-service pour contrôler et configurer les composants individuels. L'utilitaire apigee-service se présente sous la forme suivante:

/opt/apigee/apigee-service/bin/apigee-service component_name action

component_name identifie le composant. Le composant doit se trouver sur le nœud sur lequel vous exécutez apigee-service. Selon votre configuration, les valeurs de component_name peuvent inclure:

  • apigee-cassandra (Cassandra)
  • apigee-openldap (OpenLDAP)
  • apigee-postgresql (base de données PostgreSQL)
  • apigee-qpidd (Qpidd)
  • apigee-sso (authentification unique Edge)
  • apigee-zookeeper (ZooKeeper)
  • edge-management-server (serveur de gestion)
  • edge-management-ui (nouvelle interface utilisateur de périphérie)
  • edge-message-processor (processeur de messages)
  • edge-postgres-server (serveur Postgres)
  • edge-qpid-server (serveur Qpid)
  • edge-router (routeur périphérique)
  • edge-ui (interface utilisateur classique)

En plus de ces composants, vous pouvez également appeler apigee-service sur les composants apigee-provision et apigee-validate en fonction de votre configuration.

Par exemple, pour redémarrer le routeur Edge, exécutez la commande suivante:

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

Vous pouvez déterminer la liste des composants installés sur le nœud en examinant le répertoire /opt/apigee. Ce répertoire contient un sous-répertoire pour chaque composant Edge installé sur le nœud. Chaque sous-répertoire est précédé par:

  • apigee: composant tiers utilisé par Edge. Par exemple, apigee-cassandra.
  • edge: composant Edge d'Apigee. Par exemple, edge-management-server.
  • edge-mint: composant de monétisation. Exemple : edge-mint-management-server.

La liste complète des actions d'un composant dépend du composant lui-même, mais tous les composants sont compatibles avec les actions suivantes:

  • start, stop, restart
  • status, version
  • backup, restore
  • install, uninstall

Activer la vérification du système à l'installation

Le fichier de configuration d'installation Edge prend en charge la propriété suivante:

ENABLE_SYSTEM_CHECK=y

Si vous définissez cette propriété sur "y", le programme d'installation vérifie que le système répond aux exigences de processeur et de mémoire pour le composant en cours d'installation. La valeur par défaut est "n" pour désactiver la vérification.