Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Microgateway Edge v. 3.0.x
Panoramica
L'interfaccia a riga di comando Edge Microgateway consente di controllare e gestire tutti gli aspetti di un'istanza Edge Microgateway.
Gestione dei certificati
I comandi cert ti consentono di installare e gestire la coppia di chiavi pubblica/privata utilizzata per firmare i token di connessione utilizzati dai client al fine di effettuare chiamate sicure attraverso Edge Microgateway. Le chiavi sono archiviate su Apigee Edge in una mappa chiave-valore (KVM) criptata. Edge Microgateway utilizza la chiave pubblica per convalidare i token di connessione firmati. Queste chiavi vengono generate quando esegui il comando di configurazione edgemicro, come spiegato in Configurare e configurare Edge Microgateway. Puoi utilizzare i comandi cert descritti qui per rigenerare e gestire queste chiavi, se necessario.
Installa un certificato
Installa le chiavi in una mappa chiave-valore (KVM) criptata e restituisce la chiave pubblica come output. L'ambito delle coppie di chiavi è un'organizzazione specificata.
Utilizzo
edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-f, --force |
(Facoltativo) Se una chiave è già archiviata nel KVM criptato, forzane la sostituzione. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro cert install -o docs -e test -u jdoe@example.com -f
Output
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 password: deleting vault creating vault adding private_key adding public_key installed cert
Eliminare un certificato
Elimina la coppia di chiavi per un'organizzazione.
Utilizzo
edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro cert delete -o docs -e test -u jdoe@example.com
Output
deleting vault Vault deleted!
Controllare un certificato
Verifica che nella tua organizzazione sia installato un certificato.
Utilizzo
edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro cert check -o docs -e test -u jdoe@example.com
Output (Operazione riuscita)
checked cert successfully
Output (Errore)
Se il certificato non esiste, viene restituito un errore.
Recupera la chiave pubblica
Restituisce la chiave pubblica dell'organizzazione specificata. Non richiede l'autenticazione.
Utilizzo
edgemicro cert public-key -o [organization] -e [environment]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro cert public-key -o docs -e test
Output (esempio)
-----BEGIN CERTIFICATE----- MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+ L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4 jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL 0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7 zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4 RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe 2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o 6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY x9gfPf1/+qo=? -----END CERTIFICATE-----
Configurazione di Edge Microgateway per Apigee Edge Cloud
Abilita Edge Microgateway per operare con un'istanza Cloud Apigee Edge. Aggrega ed esegue una sequenza di comandi per eseguire il deployment di un proxy di autenticazione richiesto su Edge, generare token di autenticazione e aggiornare i file di configurazione. Per un esempio funzionante completo, consulta la pagina relativa all'impostazione e alla configurazione di Edge Microgateway.
Utilizzo
edgemicro configure -o [organization] -e [environment] -u [username] -p [password]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-r, --url |
(Facoltativo) Specifica l'alias host virtuale per organizzazione:ambiente. Consulta la documentazione di Edge per informazioni sugli host virtuali. Valore predefinito:
org-env.apigee.net |
-c, --configDir |
(Facoltativo) Specifica il percorso del file di configurazione del Microgateway Edge. Per impostazione predefinita, il file di configurazione è in ./config/config.yaml. (Aggiunta v2.4.x) |
-x, --proxyName |
(Facoltativo) Imposta il percorso base per il proxy edgemicro-auth. Se viene eseguito il deployment del proxy edgemicro-auth utilizzando un percorso diverso da quello predefinito, /edgemicro-auth, questa funzionalità consente di impostare il nuovo percorso in Edge Microgateway. Per impostazione predefinita, il percorso di base è /edgemicro-auth. (Aggiunta v2.4.x) |
-t, --token |
(Facoltativo) Consente di utilizzare un token OAuth per l'autenticazione anziché nome utente/password.
Vedi anche Proteggere le chiamate API con un token di accesso OAuth2.
Ad esempio:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts |
(Facoltativo) Esegue l'override degli host virtuali predefiniti, che sono "default,secure". Utilizza questa opzione se per l'organizzazione Edge sono specificati altri host diversi da questi valori predefiniti. Consulta la documentazione di Edge per informazioni sugli host virtuali. |
-d, --debug |
(Facoltativo) Fornisce informazioni di debug. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Note sull'utilizzo
Questo comando archivia le informazioni di configurazione in ~/.edgemicro/org-env-config.yaml.
Esempio
edgemicro configure -o docs -e test -u jdoe@example.com
Output
Se l'operazione va a buon fine, il comando restituisce un set di chiavi che devi utilizzare quando avvii Edge Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Generazione di chiavi
Il comando genkeys genera una coppia chiave e secret utilizzata da Edge Microgateway per autenticarsi quando pubblica in modo asincrono dati di analisi su Apigee Edge.
Utilizzo
edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-t, --token |
(Facoltativo) Consente di utilizzare un token OAuth per l'autenticazione anziché nome utente/password.
Vedi anche Proteggere le chiamate API con un token di accesso OAuth2.
Ad esempio:edgemicro genkeys -o docs -e test -t <your token> |
-h, --help |
Output delle informazioni sull'utilizzo. |
Note sull'utilizzo
Se l'operazione ha esito positivo, il comando restituisce tre elementi. Il primo è un URL da inserire nel file di configurazione. Le altre due sono una coppia di chiavi richiesta quando si avvia un'istanza Edge Microgateway.
- URL di bootstrap: questo URL rimanda a un servizio Apigee Edge che consente
a un'istanza Edge Microgateway di inviare dati di analisi ad Apigee Edge. Devi copiare questo URL
nel file di configurazione di Edge Microgateway: ~
/.edgemicro/org-env-config.yaml. - key: la chiave. Questa chiave e il secret sono obbligatori come input nel comando dell'interfaccia a riga di comando utilizzato per avviare un'istanza di Edge Microgateway.
- secret: il segreto.
Esempio
edgemicro genkeys -o docs -e test -u jdoe@example.com
Output (esempio)
Se l'operazione va a buon fine, il comando restituisce un set di chiavi che devi utilizzare quando avvii Edge Microgateway.
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1 Please copy the following property to the edge micro agent config bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test The following credentials are required to start edge micro key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae finished
Configurazione di Edge Microgateway per Apigee Edge Private Cloud in corso...
Configura Edge Microgateway in modo che funzioni con un'installazione di cloud privato Apigee Edge.
Utilizzo
edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-r, --runtime-url |
Specifica l'URL di runtime per la tua istanza cloud privata. |
-m, --mgmt-url |
L'URL del server di gestione per la tua istanza cloud privato. |
-v, --virtualHosts |
Elenco separato da virgole di host virtuali per organizzazione:ambiente. Valore predefinito
"default,secure". |
-c, --configDir |
(Facoltativo) Specifica il percorso del file di configurazione del Microgateway Edge. Per impostazione predefinita, il file di configurazione è in ./config/config.yaml. (Aggiunta v2.4.x) |
-t, --token |
(Facoltativo) Consente di utilizzare un token OAuth per l'autenticazione anziché nome utente/password.
Vedi anche Proteggere le chiamate API con un token di accesso OAuth2.
Ad esempio:edgemicro configure -o docs -e test -t <your token> |
-d, --debug |
(Facoltativo) Fornisce informazioni di debug. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Note sull'utilizzo
Questo comando archivia le informazioni di configurazione in ~/.edgemicro/org-env-config.yaml.
Esempio
edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080
Output
Se l'operazione va a buon fine, il comando restituisce un set di chiavi che devi utilizzare quando avvii Edge Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Microgateway di partenza
Prima di avviare Edge Microgateway, devi eseguire la configurazione di edgemicro (cloud pubblico) o la configurazione privata di edgemicro (cloud privato). Il comando di configurazione restituisce i valori della chiave e del secret necessari per avviare Edge Microgateway.
Utilizzo
edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-k, --key |
Il valore chiave restituito che viene restituito quando esegui il comando "edgemicro
configure". |
-s, --secret |
Il valore del secret restituito che viene restituito quando esegui il comando "edgemicro
configure". |
-p, --processes |
(Facoltativo) Il numero di processi da avviare. Valore predefinito: il numero di core nel sistema. |
-d, --pluginDir |
(Facoltativo) Percorso assoluto alla directory dei plug-in. |
-r, --port |
(Facoltativo) Sostituisce il numero di porta specificato nel
file ~/.edgemicro/org-env-config.yaml. Valore predefinito: 8000 |
-c, --cluster |
(Facoltativo) Avvia Edge Microgateway in modalità cluster. Nota: a partire dalla versione 2.3.1, questa opzione è stata rimossa. Nella v2.3.1 e nelle versioni successive, Edge Micro si avvia sempre in modalità cluster. |
-c, --configDir |
(Facoltativo) Specifica il percorso del file di configurazione del Microgateway Edge. Per impostazione predefinita, il file di configurazione è in ./config/config.yaml. (Aggiunta v2.4.x) |
-u, --configUrl |
(Facoltativo) Specifica un endpoint da cui Edge Microgateway scaricherà il proprio file di configurazione. (Aggiunta v2.5.x) |
-d, --debug |
(Facoltativo) Fornisce informazioni di debug. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Impostazione della porta
Il comando start consente di specificare un numero di porta per sostituire la porta specificata
nel file di configurazione. Puoi anche specificare un numero di porta utilizzando la variabile di ambiente PORT. Ad esempio:
edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002
o
export PORT=8002 edgemicro start -o org -e test -k key -s secret -p 2
Se la porta è in uso, Edge Microgateway restituisce un errore.
Informazioni sul clustering
Edge Microgateway utilizza il modulo cluster Node.js per abilitare il clustering. Il clustering consente a Edge Microgateway di sfruttare i sistemi multi-core. Per maggiori dettagli, consulta questa documentazione su Node.js.
Esempio
edgemicro start -o docs -e test -k abc123 -s xyz456
Esempio di output:
... current nodejs version is v12.5.0 current edgemicro version is 3.0.2 info: jwk_public_keys download from null returned 200 undefined info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK PROCESS PID : 17991
Gestione dei token
I comandi token ti consentono di ottenere, decodificare e verificare i token di accesso OAuth2
firmati. Vedi anche
Proteggere le chiamate API con un token di accesso OAuth2.
Decodificare un token
Decodifica un token di connessione codificato e firmato nella sua rappresentazione JSON JWT (Java Web Token) in testo normale. Un token fornisce informazioni sull'app per sviluppatori Apigee Edge che ha fornito le chiavi utilizzate per crearlo, tra cui nome applicazione, client_id, elenco di prodotti e altro ancora.
Utilizzo
edgemicro token decode -f [filename]
Parametri
| Parametri | Descrizione |
|---|---|
-f, --file |
Il nome di un file contenente il token JWT da decodificare. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro token decode -f token.jwt
Output (esempio)
{ header: { typ: 'JWT', alg: 'RS256' },
payload:
{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
scopes: [],
api_product_list: [ 'MicroTest' ],
iat: 1436280566,
exp: 1436282365 },
signature: '' }
Genera un token
Genera un token di connessione firmato. Il token consente alle app client di effettuare chiamate API autenticate a Edge Microgateway. Si tratta di un token JWT (JSON Web Token) conforme a OAuth 2.0. Richiede come input i valori della chiave consumer (ID client) e del secret del cliente (client secret) di un'app sviluppatore registrata su Apigee Edge. Vedi anche Proteggere le chiamate API con un token di accesso OAuth2.
Utilizzo
edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-1, --key |
L'ID client dell'app sviluppatore associato al tuo proxy sensibile al Microgateway. |
-s, --secret |
Il client secret dell'app sviluppatore associato al proxy sensibile al Microgateway. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz
Output (esempio)
{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }
Verificare un token
Verifica un token di connessione firmato in base alla chiave pubblica archiviata su Apigee Edge per l'organizzazione e l'ambiente specificati.
Utilizzo
edgemicro token verify -o [org] -e [env] -f [filename]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-f, --file |
Il nome di un file contenente il codice JWT da verificare. |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro token get -o docs -e test -f token.jwt
Output di esempio per un token valido
{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',
scopes: [],
api_product_list: [ 'MicroTest' ],
iat: 1436396155,
exp: 1436397954 }
Output di esempio per token non valido
{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }
Output di esempio per il token scaduto
{ [TokenExpiredError: jwt expired]
name: 'TokenExpiredError',
message: 'jwt expired',
expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }
Inizializzazione di una nuova configurazione Edge Microgateway
Esegui questo comando una volta dopo la prima installazione di Edge Microgateway. Crea un nuovo file di configurazione predefinito: ~/.edgemicro/default.yaml.
Utilizzo
edgemicro init
Parametri
| Parametri | Descrizione |
|---|---|
-c, --configDir |
(Facoltativo) Specifica il percorso del file di configurazione del Microgateway Edge. Per impostazione predefinita, il file di configurazione è in ./config/config.yaml. (Aggiunta v2.4.x) |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro init
Output (Operazione riuscita)
config initialized to /MyHome/.edgemicro/default.yaml
Verifica della configurazione di Edge Microgateway
Verifica che Edge Microgateway sia configurato correttamente.
Utilizzo
edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parametri
Esempio
edgemicro verify -o docs -e test -k abc123 -s xyz456
Output (Operazione riuscita)
logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988 installed plugin from analytics installed plugin from oauth a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000 verifying analytics negative case: OK verifying bootstrap url availability:OK verifying jwt_public_key availability: OK verifying products availability: OK verifying quota with configured products: OK verifying analytics with payload: OK verification complete
Controlla lo stato del cluster microgateway
Per impostazione predefinita, Edge Microgateway viene avviato in modalità cluster. Puoi utilizzare questo comando per controllare lo stato del cluster.
Utilizzo
edgemicro status
Parametri
| Parametri | Descrizione |
|---|---|
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro status
Output (Operazione riuscita)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 edgemicro is running with 8 workers
Arresto del cluster microgateway
Arresto del cluster Edge Microgateway.
Utilizzo
edgemicro stop
Parametri
| Parametri | Descrizione |
|---|---|
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro stop
Output (Operazione riuscita)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 Stop Completed Successfully
Ricaricamento del cluster microgateway in corso...
Fornisce il riavvio senza tempo di inattività dopo una modifica alla configurazione. Ricarica il Microgateway Edge estraendo una nuova configurazione.
Utilizzo
edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-k, --key |
Il valore chiave restituito che viene restituito quando esegui il comando "edgemicro
configure". |
-s, --secret |
Il valore del secret restituito che viene restituito quando esegui il comando "edgemicro
configure". |
-h, --help |
Output delle informazioni sull'utilizzo. |
Esempio
edgemicro reload -o docs -e test -k abc123 -s xyz456
Output (Operazione riuscita)
... Reload Completed Successfully
Upgrade del KVM
Per utilizzare la rotazione delle chiavi, devi aver installato una mappa chiave-valore aggiornata nell'organizzazione Apigee Edge. (Aggiunta v2.5.x)
Nota: se hai configurato l'istanza Edge Micro attuale prima della versione 2.5.2, devi eseguire l'upgrade del KVM per utilizzare la rotazione della chiave. L'upgrade deve essere eseguito una sola volta.Utilizzo
edgemicro upgradekvm -o [organization] -e [environment] -u [username]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-v, --virtualhost |
(Facoltativo) L'host virtuale del proxy. |
-t, --token |
(Facoltativo) Consente di utilizzare un token OAuth per l'autenticazione anziché nome utente/password.
Vedi anche Proteggere le chiamate API con un token di accesso OAuth2.
Ad esempio:edgemicro upgradekvm -o docs -e test -t <your token> |
-b, --baseuri |
(Facoltativo) L'URI di base per la tua organizzazione su Apigee Edge. Il valore predefinito è l'URI di base per i deployment cloud di Apigee è api.enterprise.apigee.com. Per i deployment on-premise, l'URL di base potrebbe essere diverso. |
Esempio
edgemicro upgradekvm -o docs -e test -u jdoe@example.com
Output (Operazione riuscita)
Se l'operazione ha esito positivo, il comando restituisce un output simile al seguente:
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 password: Checking for certificate... Certificate found! -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ 3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1 HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5 WQIDAQAB -----END PUBLIC KEY----- KVM update complete
Upgrade del proxy di autenticazione perimetrale
Per utilizzare la rotazione della chiave, devi disporre di un proxy di autenticazione edgemicro aggiornato nella tua organizzazione Apigee Edge. (Aggiunta v2.5.x)
Nota: se hai configurato l'istanza Edge Micro attuale prima della versione 2.5.2, devi eseguire l'upgrade di questo proxy se vuoi utilizzare la rotazione delle chiavi. L'upgrade deve essere eseguito una sola volta.
Utilizzo
edgemicro upgradeauth -o [organization] -e [environment] -u [username]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-v, --virtualhost |
(Facoltativo) L'host virtuale del proxy. |
-b, --baseuri |
(Facoltativo) L'URI di base per la tua organizzazione su Apigee Edge. Il valore predefinito è l'URI di base per i deployment cloud di Apigee è api.enterprise.apigee.com. Per i deployment on-premise, l'URL di base potrebbe essere diverso. |
Esempio
edgemicro upgradeauth -o docs -e test -u jdoe@example.com
Output (Operazione riuscita)
Se l'operazione ha esito positivo, il comando restituisce un output simile al seguente:
Going to create revision 2 of API edgemicro-auth Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file Creating revision 2 of API edgemicro-auth Uploading java resource micro-gateway-products-javacallout-2.0.0.jar Uploading jsc resource generate-verify-jwt.js Uploading jsc resource send-public-key.js Uploading jsc resource set-jwt-variables.js Uploading jsc resource set-response.js Uploading node resource index.js Uploading node resource node_modules_apigee-access.zip Uploading node resource node_modules_base64url.zip Uploading node resource node_modules_buffer-equal-constant-time.zip Uploading node resource node_modules_ecdsa-sig-formatter.zip Uploading node resource node_modules_jsrsasign.zip Uploading node resource node_modules_jwa.zip Uploading node resource node_modules_jws.zip Uploading node resource node_modules_safe-buffer.zip Uploading node resource package.json Uploading policy Access-App-Info-2.xml Uploading policy Access-App-Info.xml Uploading policy AccessTokenRequest.xml Uploading policy Add-Custom-Claims.xml Uploading policy Create-OAuth-Request.xml Uploading policy Create-Refresh-Request.xml Uploading policy Extract-API-Key.xml Uploading policy Extract-OAuth-Params.xml Uploading policy Extract-Refresh-Params.xml Uploading policy Get-Private-Key.xml Uploading policy Get-Public-Key.xml Uploading policy Get-Public-Keys.xml Uploading policy JavaCallout.xml Uploading policy Products-to-JSON-2.xml Uploading policy Products-to-JSON.xml Uploading policy Raise-Fault-Unknown-Request.xml Uploading policy RefreshAccessToken.xml Uploading policy Send-Public-Key.xml Uploading policy Set-JWT-Variables.xml Uploading policy Set-Response.xml Uploading policy Verify-API-Key.xml Uploading target TargetEndpoint-1 Uploading proxy default Deploying revision 2 of edgemicro-auth to test Deployment on test successful edgemicro-auth proxy upgraded
Rotazione delle chiavi
Utilizza il comando edgemicro rotatekey per ruotare le coppie di chiavi pubbliche/private utilizzate per generare i token JWT utilizzati per la sicurezza OAuth su Edge Microgateway.
Per scoprire di più, consulta la sezione Rotazione delle chiavi JWT.
Utilizzo
edgemicro rotatekey -o [organization] -e [environment] -u [username] -k [kid]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
(Obbligatorio) L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
(Obbligatorio) Un ambiente per il quale hai configurato Edge Microgateway. |
| -u, --nomeutente | (Obbligatorio) Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-k, --kid |
(Obbligatorio) Un ID utilizzato per associare una chiave specifica. Edge Microgateway utilizza questo valore per scegliere tra un set di chiavi durante la rotazione della chiave. Per maggiori informazioni, consulta la Sezione 4.5 della specifica JSON Web Key. |
-b, --baseuri |
(Facoltativo) L'URI di base per la tua organizzazione su Apigee Edge. Il valore predefinito è l'URI di base per i deployment cloud di Apigee è api.enterprise.apigee.com. Per i deployment on-premise, l'URL di base potrebbe essere diverso. |
Esempio
edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2
Output (Operazione riuscita)
Se l'operazione ha esito positivo, il comando restituisce un output simile al seguente:
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 password: Checking if private key exists in the KVM... Checking for certificate... Found Certificate Generating New key/cert pair... Extract new public key Key Rotation successfully completed!
Dopo la rotazione, puoi vedere nell'interfaccia utente perimetrale che sono state aggiunte nuove chiavi al KVM microgateway.
Monitoraggio costante
Utilizza il comando edgemicro forever per gestire il processo Forever, uno strumento Node.js che riavvia automaticamente un'app Node.js in caso di malfunzionamento o errore.
Vedi anche
Monitoraggio permanente.
Utilizzo
Prima di eseguire il comando edgemicro forever, devi impostare le seguenti variabili di ambiente:
EDGEMICRO_ORG: l'organizzazione Apigee per cui hai configurato Edge Microgateway.EDGEMICRO_ENV: un ambiente per il quale hai configurato Edge Microgateway.EDGEMICRO_KEY: il valore della chiave restituito quando hai eseguito il comando "edgemicro configure".EDGEMICRO_SECRET: il valore del secret restituito quando hai eseguito il comando "edgemicro configure".
edgemicro forever -f [forever_file] -a [start|stop]
Parametri
| Parametro | Descrizione |
|---|---|
-f, --file | Specifica la posizione del file forever.json. |
-a, --action | start o stop. L'impostazione predefinita è l'avvio. |
Esempi:
Per avviare Per sempre:
edgemicro forever -f ~/mydir/forever.json -a start
Per interrompere definitivamente:
edgemicro forever -a stop
Revoca chiavi
Utilizza il comando edgemicro revokekeys per revocare la chiave e le credenziali del secret per una configurazione di Edge Microgateway.
Utilizzo
edgemicro revokekeys -o [organization] -e [environment] -u [username] -k [key] -s [secret]
Parametri
| Parametri | Descrizione |
|---|---|
-o, --org |
(Obbligatorio) L'organizzazione Apigee per la quale hai configurato Edge Microgateway. |
-e, --env |
(Obbligatorio) Un ambiente per il quale hai configurato Edge Microgateway. |
-u, --username |
(Obbligatorio) Il tuo nome utente Apigee. Devi essere un amministratore dell'organizzazione specificata. |
-p, --password |
(Facoltativo) La tua password. Se non fornisci questo parametro nella riga di comando, ti verrà richiesto di farlo. |
-k, --key |
(Obbligatorio) La chiave da revocare. |
-s, --secret |
(Obbligatorio) Il secret da revocare. |
Esempi
edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com -k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513
In caso di esito positivo, verrà visualizzato il seguente messaggio:
key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully