Configurer Edge

Edge pour Private Cloud v4.18.05

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

Apigee fait référence à la technique d'édition des fichiers .properties sous forme de code avec configuration. En bref, le code avec configuration est un outil de recherche clé-valeur basé sur les paramètres les fichiers .properties. Dans le code avec configuration, les clés sont appelées jetons. Par conséquent, pour configurer Edge, vous définissez des jetons dans .properties .

Le code avec configuration permet aux composants Edge de définir des valeurs par défaut fournies avec le permet à l'équipe d'installation de remplacer ces paramètres en fonction de la topologie de l'installation, et permet aux clients de remplacer les propriétés de leur choix.

Si vous le considérez comme une hiérarchie, les paramètres sont organisés comme suit : paramètres ayant la priorité la plus élevée pour remplacer ceux de l'équipe d'installation ou Apigee:

  1. Client
  2. Installateur
  3. Apigee

Utiliser les fichiers .properties

En tant que client, vous ne pouvez modifier que les fichiers .properties de la section /opt/apigee/customer/application. Chaque composant a sa propre .properties dans ce répertoire. Exemple : router.properties et management-server.properties.

Par exemple, pour créer un fichier .properties:

  1. Créez le fichier dans un éditeur en tant qu'utilisateur.
  2. Utilisez chown pour remplacer le propriétaire du fichier par "apigee:apigee" ou, si vous avez changé l'utilisateur exécutant le service Edge à partir de la plateforme « apigee » la commande "chown" du fichier à l'utilisateur exécute le service Edge.

Pour définir la propriété d'un composant, modifiez le fichier .properties correspondant afin de définir un jeton, puis redémarrez le composant:

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

Par exemple, après avoir modifié router.properties, redémarrez le routeur:

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

Lorsque vous mettez à niveau Edge, les fichiers .properties du /opt/apigee/customer/application sont lus. Cela signifie que la migration et conserve toutes les propriétés que vous avez définies sur le composant.

Emplacement des fichiers .properties

Il existe trois répertoires de premier niveau pour les fichiers .properties pour Edge composants: installation, propriétaire et clients. Les emplacements par défaut sont indiqués ci-dessous tableau:

Propriétaire Répertoire racine du jeton par défaut
Composant 
/opt/apigee/component_name/conf

Où component_name identifie le composant. Valeurs possibles incluent:

  • 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)
Installation 
/opt/apigee/token
Client 
/opt/apigee/customer

Déterminer la valeur actuelle d'un jeton

Avant de définir un jeton dans le fichier .properties pour le composant, vous pouvez d'abord déterminer sa valeur actuelle à l'aide de la commande suivante:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

Où component_name est le nom du composant, et token est le jeton à inspecter.

Cette commande recherche dans la hiérarchie des fichiers .properties pour déterminer la valeur actuelle du jeton.

Par exemple, pour vérifier la valeur actuelle de conf_http_HTTPRequest.line.limit pour le routeur:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Le résultat doit s'afficher au format suivant :

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

Définir des jetons dans des fichiers .properties

Pour remplacer la valeur d'un jeton:

  1. Modifiez le fichier .properties du composant pour définir la valeur du jeton. Si le fichier n'existe pas, alors créez-le.
  2. Redémarrez le composant.
  3. Vérifiez la valeur du jeton.

Par exemple, pour définir la limite de ligne de requête pour le routeur Edge:

  1. Modifiez le fichier /opt/apigee/customer/application/router.properties pour définir Jeton conf_http_HTTPRequest.line.limit: 
    conf_http_HTTPRequest.line.limit=8k
  2. Redémarrez le routeur Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  3. Vérifiez la valeur du jeton: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Définir un jeton acceptant plusieurs valeurs

Certains jetons utilisent une liste de valeurs séparées par une virgule. Par exemple, Le jeton conf_security_rbac.restricted.resources prend une liste d'URI restreints afin que seul l'administrateur système peut les appeler. Pour afficher la valeur de conf_security_rbac.restricted.resources:

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

Le résultat contient les éléments suivants :

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

Pour définir un jeton qui reçoit une liste de valeurs, ajoutez les nouvelles valeurs à la valeur actuelle du paramètre dans le fichier .properties. Par conséquent, pour ajouter l'URI /myuri/* à conf_security_rbac.restricted.resources, modifiez le fichier /opt/apigee/customer/application/management-server.properties comme indiqué. ci-dessous:

conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

Trouver un jeton

Dans la plupart des cas, les jetons que vous devez définir sont identifiés dans ce guide. Toutefois, si vous avez besoin Pour déterminer le jeton utilisé pour remplacer une propriété, effectuez une grep dans la Dossier source du composant.

Par exemple, si vous savez que, dans une version précédente d'Edge, vous avez défini le session.maxAge et que vous souhaitez connaître la valeur de jeton utilisée pour la définir, puis grep pour la propriété dans le répertoire /opt/apigee/edge-ui/source:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

Le résultat doit s'afficher sous la forme suivante:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

La chaîne entre les balises {T}{/T} est le jeton que vous définissez dans le fichier .properties.

Définir un jeton qui est actuellement commenté

Certains jetons sont commentés dans les fichiers de configuration Edge. Si vous essayez de définir un jeton est commenté, le paramètre est ignoré.

Pour définir un jeton commenté, vous utilisez une syntaxe spéciale, au format suivant:

conf/file.extension+propertyName=propertyValue

Par exemple, vous souhaitez définir la propriété HTTPClient.proxy.host sur l'ensemble de données Processeur. Vous exécutez ensuite la commande grep de la propriété pour déterminer son jeton:

cd /opt/apigee/edge-message-processor
grep -ri "HTTPClient.proxy.host" *

La commande grep renvoie les résultats au format incluant la valeur du jeton. Avertissement la manière dont le nom de la propriété est commenté, comme indiqué par le préfixe # sur la ligne nom de la propriété:

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

Pour définir la propriété, modifiez /opt/apigee/customer/application/message-processor.properties pour définir la propriété comme suit:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

Notez que le nom de la propriété est précédé de conf/http.properties+, l'emplacement et le nom du fichier de configuration contenant la propriété, suivi du signe "+".

Après avoir redémarré le processeur de messages, examinez le fichier /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

À la fin du fichier, vous verrez la propriété définie, sous la forme:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com