Come configurare Edge

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 si riferisce alla tecnica di modifica dei file .properties come codice con configurazione (a volte abbreviato in CwC). 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 disposte 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. Componente

Determinare il valore attuale di un token

Prima di impostare un nuovo valore per un token in un file .properties, devi prima 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 del componente per determinare il valore corrente del token.

L'esempio seguente controlla il valore corrente 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 vedere un output simile al seguente:

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

Se il valore del token inizia con #, è stato commentato e devi utilizzare una sintassi speciale per modificarlo. Per saperne di più, consulta Imposta un token attualmente commentato.

Se non conosci il nome completo del token, utilizza uno strumento come grep per eseguire la ricerca in base al nome della proprietà o alla parola chiave. Per saperne di più, consulta Individua un token.

File delle proprietà

Esistono file di configurazione dei componenti modificabili e non modificabili. Questa sezione descrive questi file.

File di configurazione dei componenti modificabili

La tabella seguente elenca i componenti Apigee e i file delle proprietà che puoi modificare per configurare questi componenti:

Se vuoi impostare una proprietà in uno di questi file di configurazione dei componenti, ma non esiste, puoi crearla nella posizione indicata sopra.

Inoltre, devi assicurarti che il file delle proprietà sia di proprietà dell'utente "apigee":

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

File di configurazione dei componenti non modificabili

Oltre ai file di configurazione dei componenti modificabili, esistono anche file di configurazione che non puoi modificare.

I file informativi (non modificabili) includono:

/opt/apigee/token

/opt/apigee/component_name/conf

Imposta un valore del token

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. Per un elenco completo dei file delle proprietà, consulta Posizione dei file .properties.

Per creare un file .properties:

1. Crea un nuovo file di testo in un editor. Il nome del file deve corrispondere all'elenco mostrato nella tabella riportata sopra per i file dei clienti.
2. Cambia il proprietario del file in "apigee:apigee", come mostrato nell'esempio seguente:

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Se hai modificato l'utente che esegue il servizio Edge dall'utente "apigee", utilizza chown per modificare la proprietà dell'utente che esegue il servizio Edge.

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.

Per impostare il valore di un token:

1. Modifica il file .properties del componente.
2. Aggiungi o modifica il valore del token. L'esempio seguente imposta il valore della proprietà conf_http_HTTPRequest.line.limit su "10k":

   conf_http_HTTPRequest.line.limit=10k

   Se il token accetta più valori, separa ogni valore con una virgola, come mostrato nell'esempio seguente:

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

   Per aggiungere un nuovo valore a un elenco di questo tipo, in genere lo aggiungi alla fine dell'elenco.

3. Riavvia il componente:

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   Dove component_name è uno dei seguenti:

   • 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)

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

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

4. (Facoltativo) Verifica che il valore del token sia impostato sul nuovo valore utilizzando l'opzione configure -search. Ad esempio:

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

   Per saperne di più su configure -search, consulta Determina il valore corrente di un token.

Individua un token

Nella maggior parte dei casi, i token da impostare sono identificati in questa guida. Tuttavia, se devi eseguire l'override del valore di un token esistente di cui non conosci il nome completo o la posizione, utilizza grep per eseguire una ricerca nella directory 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, 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 seguente formato:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

L'esempio seguente mostra il valore del token session.maxAge della UI:

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

La stringa tra i tag {T}{/T} è il nome del token che puoi impostare nel file .properties della UI.

Imposta un token attualmente commentato

Alcuni token sono commentati nei file di configurazione di Edge. Se provi a impostare un token che è stato commentato in un file di configurazione di installazione o di componente, l'impostazione viene ignorata.

Per impostare il valore di un token commentato in un file di configurazione Edge, utilizza una sintassi speciale nel seguente formato:

conf/filename+propertyName=propertyValue

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

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

Il comando grep restituisce risultati che includono il nome del token. Nota come il nome della proprietà è stato commentato, come indicato dal prefisso #:

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 il valore di questa proprietà, modifica /opt/apigee/customer/application/message-processor.properties, ma utilizza una sintassi speciale, come mostrato nell'esempio seguente:

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

In questo caso, devi anteporre conf/http.properties+ al nome della proprietà. Si tratta della posizione e del 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=myhost.name.com