Come configurare Edge

Edge for Private Cloud v4.18.05

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

Apigee definisce la tecnica di modifica dei file .properties come codice con configurazione. In sostanza, il codice con configurazione è uno strumento di ricerca di chiavi/valori basato sulle impostazioni dei file .properties. Nel codice con configurazione, le chiavi sono chiamate token. Pertanto, per configurare Edge, devi impostare i token nei file .properties.

Il codice con configurazione consente ai componenti Edge di impostare i valori predefiniti forniti con il prodotto, consente al team di installazione di eseguire l'override di queste impostazioni in base alla topologia di installazione e consente ai clienti di eseguire l'override di tutte le proprietà scelte.

Se la consideri una gerarchia, le impostazioni sono organizzate come segue, con le impostazioni del cliente che hanno la priorità più alta per eseguire l'override di qualsiasi impostazione del team di installazione o di Apigee:

  1. Cliente
  2. Installatore
  3. Apigee

Come utilizzare i file .properties

In qualità di cliente, puoi modificare solo i file .properties nella directory /opt/apigee/customer/application. Ogni componente ha il proprio file .properties in quella directory. Ad esempio, router.properties e management-server.properties.

Ad esempio, per creare un file .properties:

  1. Crea il file in un editor come qualsiasi utente.
  2. Utilizza chown per cambiare il proprietario del file in "apigee:apigee" o, se hai cambiato l'utente che esegue il servizio Edge dall'utente "apigee", modifica il proprietario del file impostandolo sull'utente che esegue il servizio Edge.

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

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

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

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

Quando esegui l'upgrade di Edge, i file .properties nella directory /opt/apigee/customer/application vengono letti. Ciò significa che l'upgrade manterrà tutte le proprietà impostate sul componente.

Posizione dei file .properties

Esistono tre directory di primo livello per i file .properties per i componenti Edge: installazione, proprietario e clienti. Le località predefinite sono riportate nella tabella seguente:

Proprietario Directory root dei token predefinita
Componente 
/opt/apigee/component_name/conf

Dove component_name identifica il componente. I valori possibili includono:

  • apigee-cassandra (Cassandra)
  • apigee-openldap (OpenLDAP)
  • apigee-postgresql (database PostgreSQL)
  • apigee-qpidd (qpidd)
  • apigee-sso (SSO perimetrale)
  • apigee-zookeeper (ZooKeeper)
  • edge-management-server (server di gestione)
  • edge-management-ui (nuova UI di Edge)
  • edge-message-processor (Elaboratore messaggi)
  • edge-postgres-server (server Postgres)
  • edge-qpid-server (server Qpid)
  • edge-router (router Edge)
  • edge-ui (UI classica)
Installazione 
/opt/apigee/token
Cliente 
/opt/apigee/customer

Determinare il valore attuale di un token

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

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

Dove component_name è il nome del componente e token è il token da ispezionare.

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

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

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

Dovresti visualizzare un output nel seguente formato:

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

Imposta i token nei file .properties

Per eseguire l'override del valore di un token:

  1. Modifica il file .properties del componente 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 della riga di richiesta per il router perimetrale:

  1. Modifica il file /opt/apigee/customer/application/router.properties per impostare il token conf_http_HTTPRequest.line.limit: 
    conf_http_HTTPRequest.line.limit=8k
  2. Riavvia il router perimetrale: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  3. Controlla il valore del token: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Imposta un token che accetta più valori

Alcuni token accettano 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 il sysadmin possa chiamarli. Per visualizzare il valore di conf_security_rbac.restricted.resources:

cd /opt/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 accetta un elenco di valori, aggiungi i nuovi valori al valore corrente del token nel file .properties. Pertanto, per aggiungere l'URI /myuri/* a conf_security_rbac.restricted.resources, modifica il file /opt/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/*

Individua un token

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

Ad esempio, se sai che in una release precedente di Edge hai impostato la proprietà session.maxAge e vuoi conoscere il valore del token utilizzato per impostarla, esegui grep per la proprietà nella directory /opt/apigee/edge-ui/source:

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

Dovresti visualizzare un risultato nel formato:

/opt/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 hai impostato nel file .properties.

Imposta un token attualmente commentato

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

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

conf/file.extension+propertyName=propertyValue

Ad esempio, vuoi impostare la proprietà denominata HTTPClient.proxy.host sul processore di messaggi. Poi, grep la proprietà per determinarne il token:

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

Il comando grep restituisce i risultati nel formato che include il valore del token. Nota come il nome della proprietà è stato commentato, come indicato dal prefisso # sul 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 impostarla come:

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

Nota che il nome della proprietà è preceduto da conf/http.properties+, dalla posizione e dal nome del file di configurazione contenente la proprietà, seguiti 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=myhost.name.com