Riferimento CLI per Edge Microgateway

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Edge Microgateway v. 2.4.x

Panoramica

La CLI Edge Microgateway ti consente di controllare e gestire tutti gli aspetti di un'istanza di Edge Microgateway.

Gestione dei certificati

I comandi cert consentono di installare e gestire la coppia di chiavi pubblica/privata utilizzata per firmare i token di autenticazione utilizzati dai client per effettuare chiamate sicure tramite Edge Microgateway. Le chiavi vengono archiviate su Apigee Edge in una mappa chiave-valore (KVM) criptata. Edge Microgateway utilizza la chiave pubblica per convalidare i token di tipo bearer firmati. Queste chiavi vengono generate quando esegui il comando edgemicro configure, come spiegato in Configurazione di Edge Microgateway. Se necessario, puoi utilizzare i comandi cert descritti qui per rigenerare e gestire queste chiavi.

Installa un certificato

Installa le chiavi in una mappa chiave-valore (KVM) criptata utilizzando il servizio di archiviazione sicura di Apigee Edge e restituisce la chiave pubblica come output. Le coppie di chiavi sono limitate a un'organizzazione specificata.

Utilizzo

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

Parametri

Esempio

edgemicro cert install -o docs -e test -u jdoe@example.com -f

Output

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
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

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

Esempio

edgemicro cert check -o docs -e test -u jdoe@example.com

Output (Success)

checked cert successfully

Output (errore)

Se il certificato non esiste, viene restituito un errore.

Recuperare la chiave pubblica

Restituisce la chiave pubblica per l'organizzazione specificata. Non richiede l'autenticazione.

Utilizzo

edgemicro cert public-key -o [organization] -e [environment]

Parametri

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

Consente a Edge Microgateway di operare con un'istanza Apigee Edge Cloud. Esegue il wrapping e 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 di funzionamento completo, vedi Configurazione di Edge Microgateway.

Utilizzo

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

Parametri

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

In caso di esito positivo, il comando restituisce un insieme 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 delle chiavi

Il comando genkeys genera una coppia chiave-secret utilizzata da Edge Microgateway per autenticarsi durante la pubblicazione asincrona dei dati di analisi su Apigee Edge.

Utilizzo

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

Parametri

Note sull'utilizzo

In caso di esito positivo, il comando restituisce tre elementi. Il primo è un URL che devi inserire nel file di configurazione. Le altre due sono una coppia di chiavi necessarie quando avvii un'istanza di Edge Microgateway.

• URL di bootstrap: questo URL punta a un servizio Apigee Edge che consente a un'istanza di 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 segreto sono necessari come input per il comando CLI utilizzato per avviare un'istanza di Edge Microgateway.
• secret: il segreto.

Esempio

edgemicro genkeys -o docs -e test -u jdoe@example.com

Output (esempio)

In caso di esito positivo, il comando restituisce un insieme 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

Configura Edge Microgateway per funzionare con un'installazione di Apigee Edge Private Cloud.

Utilizzo

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

Parametri

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

In caso di esito positivo, il comando restituisce un insieme 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!

Avvio di Edge Microgateway

Prima di avviare Edge Microgateway, devi prima eseguire edgemicro configure (Public Cloud) o edgemicro private configure (Private Cloud). Il comando configure restituisce i valori di chiave e segreto necessari per avviare Edge Microgateway.

Utilizzo

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parametri

Impostazione della porta

Il comando start ti consente di specificare un numero di porta per eseguire l'override della 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 di Node.js.

Esempio

edgemicro start -o docs -e test -k abc123 -s xyz456

Esempio di output:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

Gestione dei token

I comandi token consentono di ottenere, decodificare e verificare i token di accesso OAuth2 firmati. Consulta anche Chiamate API sicure con un token di accesso OAuth2.

Decodificare un token

Decodifica un token di connessione firmato e codificato nella relativa rappresentazione JSON JWT (Java Web Token) in testo normale. Un token trasmette informazioni sull'app per sviluppatori Apigee Edge che ha fornito le chiavi utilizzate per creare il token, tra cui nome dell'applicazione, client_id, elenco dei prodotti e altro ancora.

Utilizzo

edgemicro token decode -f [filename]

Parametri

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: ... }

Generare un token

Genera un token di autenticazione firmato. Il token consente alle app client di effettuare chiamate API autenticate a Edge Microgateway. Il token è un token web JSON (JWT) conforme a OAuth 2.0. Richiede come input i valori di Consumer Key (ID client) e Consumer Secret (client secret) di un'app per sviluppatori registrata su Apigee Edge. Consulta anche Chiamate API sicure con un token di accesso OAuth2.

Utilizzo

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

Parametri

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' }

Invio di una richiesta HTTP per ottenere un token

Puoi anche effettuare una richiesta HTTP non elaborata per ottenere il token. Ecco un esempio di curl. Basta sostituire i nomi dell'organizzazione e dell'ambiente nell'URL e sostituire i valori di ID consumer e Segreto consumer con i parametri client_id e client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Verificare un token

Verifica un token di autenticazione firmato rispetto 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

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 un token scaduto

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

Ottenere direttamente i token di connessione

Potresti preferire ottenere i token bearer direttamente effettuando una richiesta HTTP all'endpoint token su Apigee Edge. L'endpoint token effettivo viene implementato nel proxy di cui è stato eseguito il deployment con il comando CLI deploy-edge-service.

Ecco un esempio di curl. Basta sostituire i nomi dell'organizzazione e dell'ambiente nell'URL e sostituire i valori ID consumer e Consumer secret ottenuti da un'app per sviluppatori su Apigee Edge con i parametri client_id e client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Esempio di output:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

Inizializzazione di una nuova configurazione di Edge Microgateway

Esegui questo comando una volta dopo aver installato Edge Microgateway. Crea un nuovo file di configurazione predefinito: ~/.edgemicro/default.yaml.

Utilizzo

edgemicro init 

Parametri

Esempio

edgemicro init

Output (Success)

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 (Success)

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

Aggiunta: v2.2.4-beta

Per impostazione predefinita, Edge Microgateway viene avviato in modalità cluster. Puoi utilizzare questo comando per controllare lo stato del cluster.

Utilizzo

edgemicro status

Parametri

Esempio

edgemicro status

Output (Success)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

Arresto del cluster microgateway

Aggiunta: v2.2.4-beta

Arresta il cluster Edge Microgateway.

Utilizzo

edgemicro stop

Parametri

Esempio

edgemicro stop

Output (Success)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

Ricarica del cluster microgateway

Aggiunta: v2.2.4-beta

Fornisce il riavvio senza tempi di inattività dopo una modifica alla configurazione. Ricarica Edge Microgateway recuperando una nuova configurazione.

Utilizzo

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parametri

Esempio

edgemicro reload -o docs -e test -k abc123 -s xyz456

Output (Success)

...

Reload Completed Successfully