Come configurare Edge

Edge per Private Cloud v. 4.16.05

Per configurare Edge dopo l'installazione, utilizza una combinazione di file .properties e utilità Edge. Per Ad esempio, per configurare TLS/SSL nella UI di Edge, devi modificare i file .properties per impostare le proprietà. Le modifiche ai file .properties richiedono il riavvio del componente Edge interessato.

Apigee si riferisce alla tecnica di modifica dei file .properties come codice con config. In sostanza, il codice con Config è uno strumento di ricerca di coppie chiave/valore basato sulle impostazioni nei file .properties. Nel codice con le chiavi sono dette token. Di conseguenza, per configurare Edge, devi impostare i token nei file .properties.

Il codice con configurazione consente ai componenti Edge di impostare valori predefiniti che vengono forniti con prodotto, consente al team di installazione di eseguire l'override di queste impostazioni in base alla topologia di installazione, e poi consente ai clienti di eseguire l'override delle strutture scelte da loro.

Se la pensi come una gerarchia, le impostazioni sono organizzate come segue con impostazioni con la massima priorità, per sostituire quelle del team di installazione; oppure Apigee:

  1. Cliente
  2. Installatore
  3. Apigee

Come utilizzare i file .properties

Come cliente, puoi modificare solo i file .properties nella /<inst_root>/apigee/customer/application . Ogni componente ha il proprio file .properties in questa directory. Ad esempio, router.properties e management-server.properties.

  1. Crea il file in un editor come qualsiasi utente.
  2. Contrassegna il proprietario del file in apigee:apigee o, se hai modificato l'utente. che esegue il servizio Edge dall'utente apigee, esegui il chown del file per l'utente che se il servizio Edge è in esecuzione.

Per impostare una proprietà per un componente, modifica il file .properties corrispondente per impostare un token, e riavvia il componente:

> /<inst_root>/apigee/apigee-service/bin/apigee-service component restart

Ad esempio, dopo aver modificato il file router.properties, riavvia il router:

> /<inst_root>/apigee/apigee-service/bin/apigee-service edge-router restart

Quando esegui l'upgrade di Edge, i file .properties nella /&lt;inst_root&gt;/apigee/customer/application vengono lette. Ciò significa che l'upgrade manterrà tutte le proprietà impostate nel di strumento di authoring.

Percorso dei file .properties

Esistono tre directory di primo livello per i file .properties per Edge componenti: proprietario dell'installazione e clienti. Le località predefinite vengono mostrate di seguito tabella:

Avviso: i clienti Edge possono modificare solo i file .properties in /&lt;inst_root&gt;/apigee/customer. Anche se puoi visualizzare i file nelle directory dei componenti e di installazione, non modificare il .

Proprietario

Directory root token predefinita

Componente

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

dove /&lt;prefix&gt;-&lt;component&gt; identifica il componente, ad esempio edge-router o apigee-cassandra.

Installazione

&lt;inst_root&gt;/apigee/token

Cliente

<inst_root>/apigee/customer

Determinazione del valore attuale di un token

Prima di impostare un token nel file .properties per il componente, puoi innanzitutto determinarne il valore attuale utilizzando il comando seguente:

> /<inst_dir>/apigee/apigee-service/bin/apigee-service comp configure -search token

dove comp è il nome del componente e token è il token da controllare.

Questo comando cerca nella gerarchia dei file .properties per determinare i attuale del token.

Ad esempio, per controllare il valore attuale del token conf_router_HTTP.request.line.limit per il router:

> /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_router_HTTP.request.line.limit

L'output dovrebbe essere visualizzato nel seguente formato:

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

Impostazione dei token nei file .properties

Per eseguire l'override del valore di un token:

  1. Modifica il file .properties per il parametro per impostare il valore del token. Se il file non esiste, crealo.
  2. Riavvia il componente.
  3. Controlla il valore del token.

Ad esempio, per impostare il limite di righe di richiesta per il router Edge:

  1. Modifica /&lt;inst_root&gt;/apigee/customer/application/router.properties per impostare conf_router_HTTP.request.line.limit token:

    conf_router_HTTP.request.line.limit=8k
  2. Riavvia il router perimetrale:

    &gt; /<inst_root>/apigee/apigee-service/bin/apigee-service edge-router reboot
  3. Controlla il valore del token:

    &gt; /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_router_HTTP.request.line.limit

Impostazione di un token che accetta più valori

Alcuni token utilizzano un elenco di valori separati da virgole. Ad esempio, il token conf_security_rbac.restricted.resources accetta un elenco di URI limitati in modo che solo l'amministratore di sistema possa chiamarli. Per vedere le valore di conf_security_rbac.restricted.resources:

> cd /<inst_root>/apigee/edge-management-server
> grep -ri "conf_security_rbac.restricted.resources" *

L'output contiene quanto segue:

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

Per impostare un token che accetti un elenco di valori, aggiungi eventuali nuovi valori al valore attuale dell'attributo nel file .properties. Pertanto, per aggiungere l'URI /myuri/* a conf_security_rbac.restricted.resources, modifica /&lt;inst_root&gt;/apigee/customer/application/management-server.properties come mostrato di seguito:

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

Individuazione di un token

Nella maggior parte dei casi, i token da impostare sono identificati in questa guida. Tuttavia, se hai bisogno per determinare il token utilizzato per eseguire l'override di una proprietà, esegui un comando grep nella cartella source del componente.

Ad esempio, se sai che in una versione precedente di Edge hai impostato la proprietà session.maxAge e vuoi conoscere la il valore del token utilizzato per impostarlo, quindi grep per la proprietà in /<inst_root>/apigee/edge-ui/source directory:

> grep -ri "session.maxAge" /<inst_root>/apigee/edge-ui/source

Dovresti vedere un risultato nel modulo:

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

La stringa tra i tag {T}{/T} è il token che imposti in nel file .properties.

Impostazione di un token attualmente commentato fuori

Alcuni token sono commentato nei file di configurazione di Edge. Se provi a impostare un token viene commentato, l'impostazione viene ignorata.

Per impostare un token che viene commentato, utilizza una sintassi speciale, nel formato:

conf/file.extension+propertyName=propertyValue

Ad esempio, supponiamo che tu voglia impostare la proprietà denominata HTTPClient.proxy.host sul campo Processore. Poi c'è grep per per determinarne il token:

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

Il comando grep restituisce genera il modulo che include il valore del token. Nota come viene commentato il nome della proprietà, come indicato dal prefisso # nel nome della proprietà:

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=

Per impostare la proprietà, modifica /opt/apigee/customer/application/message-processor.properties per impostare la proprietà come:

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

Nota come il nome della proprietà è preceduto dal prefisso conf/http.properties+, dalla località e dal nome del file di configurazione contenente la proprietà seguita da "+".

Dopo aver riavviato il processore di messaggi, esamina il file /opt/apigee/edge-message-processor/conf/http.properties:

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

Alla fine del file, vedrai la proprietà impostata nel formato:

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