Come configurare Edge

Edge per Private Cloud v4.19.01

Per configurare Edge dopo l'installazione, utilizza una combinazione di file .properties e utilità di Edge. Ad esempio, per configurare TLS/SSL sulla UI perimetrale, devi modificare i file .properties in modo da 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 abbreviata come CwC). Essenzialmente, il codice con configurazione è uno strumento di ricerca chiave/valore basato sulle impostazioni nei file .properties. Nel codice con configurazione, le chiavi sono denominate 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 forniti con il prodotto, consente al team di installazione di ignorare queste impostazioni in base alla topologia di installazione e consente ai clienti di ignorare le proprietà scelte.

Se la consideri una gerarchia, le impostazioni sono organizzate come segue, con le impostazioni del cliente che hanno la massima priorità 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 determinarne il valore current 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 attuale del token.

L'esempio seguente controlla 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 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 maggiori informazioni, consulta Impostare un token attualmente commentato.

Se non conosci il nome completo del token, usa uno strumento come grep per cercare in base al nome della proprietà o alla parola chiave. Per maggiori informazioni, consulta Trovare un token.

File delle proprietà

Esistono file di configurazione dei componenti modificabili e non modificabili. In questa sezione vengono descritti i file.

File di configurazione dei componenti modificabili

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

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, sono disponibili 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 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 la sezione 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 precedente 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 trasferire la proprietà all'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à che hai impostato 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 ciascun valore con una virgola, come illustrato 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 come questo, 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 corrisponde a uno dei seguenti valori:

   • 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 maggiori informazioni su configure -search, consulta Determinare il valore attuale di un token.

Individuare un token

Nella maggior parte dei casi, i token da impostare sono indicati in questa guida. Tuttavia, se devi eseguire l'override del valore di un token esistente di cui non sai con certezza il nome completo o la località, usa grep per cercare 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, allora grep per la proprietà nella directory /opt/apigee/edge-ui/source:

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

Dovresti vedere 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 dell'interfaccia utente.

Imposta un token attualmente commentato

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

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

conf/filename+propertyName=propertyValue

Ad esempio, per impostare la proprietà denominata HTTPClient.proxy.host sul processore di messaggi, devi prima grep affinché la proprietà determini 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 viene commentato il nome della proprietà, 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 illustrato nell'esempio seguente:

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

In questo caso, devi far precedere il nome della proprietà da conf/http.properties+. Questi sono la posizione e il 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 seguente formato:

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