Comment configurer Edge

Edge pour Private Cloud version 4.17.01

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

Apigee fait référence à la technique de modification des fichiers .properties en tant que code avec . En bref, le code avec configuration est un outil de recherche clé-valeur basé sur les paramètres .properties. Dans le code avec les clés sont appelées jetons. Par conséquent, pour configurer Edge, vous définissez des jetons dans les fichiers .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 dans le fichier /opt/apigee/customer/application . Chaque composant possède son propre fichier .properties dans ce répertoire. Par exemple, router.properties et management-server.properties.

<ph type="x-smartling-placeholder">
    </ph>
  1. Créez le fichier dans un éditeur en tant qu'utilisateur.
  2. Libérez la propriété du propriétaire du fichier sur apigee:apigee ou, si vous avez modifié l'utilisateur. exécutant le service Edge de l'utilisateur apigee, envoyer le fichier à l'utilisateur qui exécute le service Edge.

Pour définir la propriété d'un composant, modifiez le fichier .properties correspondant pour 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 dans le /opt/apigee/customer/application sont lus. Cela signifie que la mise à niveau conservera toutes les propriétés que vous avez définies sur .

Emplacement des fichiers .properties

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

Avertissement: Les clients Edge ne peuvent modifier que les fichiers .properties sous /opt/apigee/customer. Pendant que vous pouvez afficher les fichiers des répertoires de composants et d'installation, ne modifiez aucun fichier.

Propriétaire

Répertoire racine des jetons par défaut

Composant

/opt/apigee/&lt;prefix&gt;-&lt;component&gt;/conf

où /&lt;prefix&gt;-&lt;component&gt; identifie le composant, tel que Edge-Router ou apigee-cassandra.

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 comp configure -search token

comp 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 du jeton 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 les fichiers .properties

Pour remplacer la valeur d'un jeton:

  1. Modifiez le fichier .properties pour la classe pour définir la valeur du jeton. Si le fichier n'existe pas, 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 le jeton conf_http_HTTPRequest.line.limit:

    conf_http_HTTPRequest.line.limit=8k
  2. Redémarrez le routeur Edge:

    &gt; /opt/apigee/apigee-service/bin/apigee-service redémarrage du routeur périphérique
  3. Vérifiez la valeur du jeton:

    &gt; /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 puisse les appeler. Pour afficher les 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/*

Localiser 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é, exécutez une commande grep dans le dossier source du composant.

Par exemple, si vous savez que dans une version précédente d'Edge, vous définissez la propriété session.maxAge et souhaitez connaître le utilisée pour la définir, puis utilisez la commande 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é sur

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é nommée HTTPClient.proxy.host sur le serveur Processeur. Utilisez ensuite la commande grep pour pour déterminer son jeton:

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

La commande grep renvoie est obtenu dans le formulaire qui inclut la valeur du jeton. Notez que le nom de la propriété est commenté, comme indiqué par le préfixe # dans le 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+, de l'emplacement et du nom. du fichier de configuration contenant la propriété suivie 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=yhost.name.com