Riferimenti

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

L'interfaccia a riga di comando (CLI) di apigee-remote-service-cli consente di eseguire il provisioning e la gestione di Apigee Adapter for Envoy.

Comandi di associazione

L'associazione associa un servizio di cui è stato eseguito il deployment sul mesh Istio a un prodotto API Apigee. L'interfaccia a riga di comando consente di creare, rimuovere, elencare e verificare le associazioni.

Aggiungi un'associazione

Aggiunge un'associazione di target di servizio remoto a un prodotto API.

Utilizzo

Per Edge Public Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Per Edge Private Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

Dove:

  • target_name è il nome di una destinazione per un servizio remoto da associare al prodotto.
  • product_name è il nome di un prodotto a cui associare il servizio.

Bandiere

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni a server non sicure durante l'utilizzo di SSL
--legacy Imposta questo flag se utilizzi Apigee Edge Cloud. Imposta gli URL di gestione e runtime per Edge Cloud.
--mfa Token di autorizzazione a più fattori Apigee (utilizzato solo con --legacy)
--opdk Imposta questo flag se utilizzi Apigee Edge per il cloud privato.
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-p, --password Stringa (Obbligatorio solo per l'autenticazione di base) La tua password Apigee. Facoltativamente, puoi specificare la password in un file .netrc. Se lo fai, non dovrai fornire la password nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-t, --token Stringa (Obbligatorio solo per l'autenticazione dei token OAuth) Un token OAuth o SAML generato dai dati dell'account Apigee. Per informazioni sulla generazione dei token, consulta Utilizzare get_token e Accedere all'API di gestione con SAML.
-u, --username Stringa (Obbligatorio solo per l'autenticazione di base) Il nome utente Apigee (in genere un indirizzo email). Facoltativamente, puoi specificare il nome utente in un file .netrc. In questo caso, non dovrai fornire il tuo nome utente nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

Crea un elenco di associazioni

Elenca tutti i prodotti API associati al servizio remoto.

Utilizzo

Per Edge Public Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

Per Edge Private Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni a server non sicure durante l'utilizzo di SSL
--legacy Imposta questo flag se utilizzi Apigee Edge Cloud. Imposta gli URL di gestione e runtime per Edge Cloud.
--mfa Token di autorizzazione a più fattori Apigee (utilizzato solo con --legacy)
--opdk Imposta questo flag se utilizzi Apigee Edge per il cloud privato.
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-p, --password Stringa (Obbligatorio solo per l'autenticazione di base) La tua password Apigee. Facoltativamente, puoi specificare la password in un file .netrc. Se lo fai, non dovrai fornire la password nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-t, --token Stringa (Obbligatorio solo per l'autenticazione dei token OAuth) Un token OAuth o SAML generato dai dati dell'account Apigee. Per informazioni sulla generazione dei token, consulta Utilizzare get_token e Accedere all'API di gestione con SAML.
-u, --username Stringa (Obbligatorio solo per l'autenticazione di base) Il nome utente Apigee (in genere un indirizzo email). Facoltativamente, puoi specificare il nome utente in un file .netrc. In questo caso, non dovrai fornire il tuo nome utente nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

Rimuovere un'associazione

Rimuovi l'associazione di Remote Service for Envoy da un prodotto API.

Utilizzo

Per Edge Public Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Per Edge Private Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

Dove:

  • target_name è il nome di un target di servizio remoto di cui vuoi annullare l'associazione al prodotto.
  • product_name è il nome di un prodotto da cui svincolare il target.

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni a server non sicure durante l'utilizzo di SSL
--legacy Imposta questo flag se utilizzi Apigee Edge Cloud. Imposta gli URL di gestione e runtime per Edge Cloud.
--mfa Token di autorizzazione a più fattori Apigee (utilizzato solo con --legacy)
--opdk Imposta questo flag se utilizzi Apigee Edge per il cloud privato.
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-p, --password Stringa (Obbligatorio solo per l'autenticazione di base) La tua password Apigee. Facoltativamente, puoi specificare la password in un file .netrc. Se lo fai, non dovrai fornire la password nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-t, --token Stringa (Obbligatorio solo per l'autenticazione dei token OAuth) Un token OAuth o SAML generato dai dati dell'account Apigee. Per informazioni sulla generazione dei token, consulta Utilizzare get_token e Accedere all'API di gestione con SAML.
-u, --username Stringa (Obbligatorio solo per l'autenticazione di base) Il nome utente Apigee (in genere un indirizzo email). Facoltativamente, puoi specificare il nome utente in un file .netrc. In questo caso, non dovrai fornire il tuo nome utente nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

Verifica un'associazione

Verifica che al prodotto API associato specificato e alle relative app per sviluppatori associate sia associato anche un prodotto di servizio remoto. Se non specifichi il nome di un prodotto API, il comando controlla tutti i prodotti associati.

Utilizzo

Per Edge Public Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Per Edge Private Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

Dove product_name è facoltativo. Se non specifichi un nome di prodotto, vengono controllati tutti i prodotti associati.

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni a server non sicure durante l'utilizzo di SSL
--legacy Imposta questo flag se utilizzi Apigee Edge Cloud. Imposta gli URL di gestione e runtime per Edge Cloud.
--mfa Token di autorizzazione a più fattori Apigee (utilizzato solo con --legacy)
--opdk Imposta questo flag se utilizzi Apigee Edge per il cloud privato.
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-t, --token Stringa (Obbligatorio solo per l'autenticazione dei token OAuth) Un token OAuth o SAML generato dai dati dell'account Apigee. Per informazioni sulla generazione dei token, consulta Utilizzare get_token e Accedere all'API di gestione con SAML.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

Comando della guida

Per tutti i comandi apigee-remote-service-cli è disponibile la guida online. Digita:

apigee-remote-service-cli help

Per ricevere assistenza su qualsiasi comando, digita:

apigee-remote-service-cli [command] help

Ad esempio:

apigee-remote-service-cli provision help

Comando di provisioning

Il comando apigee-remote-service-cli provision installa un proxy nella tua organizzazione Apigee Edge, configura un certificato e genera le credenziali necessarie per configurare Apigee Adapter for Envoy.

Utilizzo

Se ti trovi in Edge Public Cloud:

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

Se ti trovi in Edge Private Cloud:

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

Parametri

Parametri Tipo Descrizione
--analytics-sa Stringa Questo flag è disponibile solo per le installazioni di Apigee hybrid e Apigee su Google Cloud.

Utilizza questo flag per specificare il percorso di un file di chiavi dell'account di servizio Google Cloud, in cui l'account di servizio ha il ruolo Apigee Analytics Agent. L'SA viene utilizzato dall'adattatore per caricare direttamente i dati di analisi in Apigee. Se utilizzi Apigee hybrid, questa opzione ti consente di installare il runtime ibrido in un cluster e l'adattatore in un altro cluster.

-c, --config Stringa Percorso del file di configurazione del servizio remoto Apigee. Vedi anche Utilizzare l'opzione --config.
-e, --environment Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-f, --force-proxy-install (Facoltativo) Forza la reinstallazione del proxy remote-service se è già installato nella tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
-k, --key Stringa Specifica la chiave restituita dal comando apigee-remote-service-cli provision.
--legacy Imposta questo flag se utilizzi Apigee Edge Cloud. Imposta gli URL di gestione e runtime per Edge Cloud.
--mfa Token di autorizzazione a più fattori Apigee (utilizzato solo con --legacy)
-m, --management Stringa (Obbligatorio se ti trovi in Apigee Private Cloud) L'URL di base di gestione di Apigee. URL predefinito: https://api.enterprise.apigee.com
-n, --namespace Stringa Emetti la configurazione come ConfigMap Envoy nello spazio dei nomi specificato. Valore predefinito: apigee
--opdk Stringa Apigee OPDK.
-o, --organization Stringa (Obbligatorio) La tua organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-p, --password Stringa (Obbligatorio solo per l'autenticazione di base) La tua password Apigee. Facoltativamente, puoi specificare la password in un file .netrc. Se lo fai, non dovrai fornire la password nella riga di comando. Vedi anche Utilizzo di .netrc per le credenziali.
--rotate-int int Se n > 0, genera una nuova chiave privata e mantieni n chiavi pubbliche (solo ibrido)
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-s, --secret Stringa Specifica il secret restituito dal comando apigee-remote-service-cli provision.
--strength int (Facoltativo) Specifica il livello di crittografia dei certificati SSL utilizzati per il provisioning dell'adattatore. Predefinito: 2048
-t, --token Stringa (Solo ambienti ibridi) Token OAuth o SAML Apigee.
-u, --username Stringa (Obbligatorio solo per l'autenticazione di base) Il nome utente Apigee (in genere un indirizzo email). Facoltativamente, puoi specificare il nome utente in un file .netrc. Vedi anche Utilizzo di .netrc per le credenziali.
-v, --verbose (Facoltativo) Genera un output dettagliato.
--virtual-hosts Stringa Esegue l'override degli host virtuali predefiniti, ovvero default,secure. Utilizza questa opzione se sono stati specificati host virtuali per l'ambiente dell'organizzazione Edge diversi da questi valori predefiniti. Per ulteriori informazioni sugli host virtuali, consulta la documentazione di Edge.
--years int (Facoltativo) Il numero di anni prima della scadenza del certificato SSL utilizzato nel provisioning. Valore predefinito: 1

Esempio

Assicurati di acquisire l'output del comando provision in un file, che viene utilizzato come input per altre operazioni di Apigee Adapter for Envoy.

Esempio di Edge Public Cloud:

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml

Comando Samples

Crea file di configurazione di esempio per i deployment nativi di Envoy o Istio.

Utilizzo

apigee-remote-service-cli samples create [flags]

Descrizione

Il comando richiede un file config.yaml valido generato tramite il provisioning. Per impostazione predefinita, l'output dei file di esempio viene eseguito in una directory denominata ./samples. Il comando crea automaticamente questa directory.

Se utilizzi Envoy nativo, il comando prende l'host di servizio di destinazione e il nome che preferisci per il relativo cluster. Imposta inoltre una connessione SSL personalizzata dal proxy Envoy al cluster di servizio remoto se una cartella contenente tls.key e tls.crt viene fornita tramite --tls.

Se utilizzi Istio, in cui il proxy Envoy agisce come sidecar e la destinazione non è specificata, verrà generato l'esempio httpbin. In caso contrario, sei responsabile della preparazione dei file di configurazione relativi al deployment dei servizi di destinazione.

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-f, --force Forza la sovrascrittura della directory esistente.
-h, --help Visualizza la guida per i parametri di comando.
--host L'host del servizio di destinazione (il valore predefinito è "httpbin.org")
-n, --name Il nome del servizio di destinazione (il valore predefinito è "httpbin")
--out La directory in cui creare i file di configurazione di esempio. URL predefinito: ./samples
-t, --template

Il nome del modello. Se stai eseguendo un deployment Istio (solo ibrido), seleziona una delle opzioni Istio disponibili. Utilizza l'opzione nativa per i deployment nativi di Envoy. Le opzioni disponibili sono:

  • istio-1.6 (valore predefinito)
  • istio-1.7
  • native
--tls La directory in cui archiviare la chiave TLS e i file crt.

Esempio

apigee-remote-service-cli samples create -c ./config.yaml

Comandi token

Puoi utilizzare un token JWT per effettuare chiamate proxy API autenticate anziché utilizzare una chiave API. I comandi dei token consentono di creare, ispezionare e ruotare i token JWT a questo scopo.

crea un token JWT

Puoi utilizzare un token JWT per effettuare chiamate proxy API autenticate a una destinazione di servizio remoto. Vedi anche Utilizzo dell'autenticazione basata su JWT.

Utilizzo

Per Edge Public Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
Per Edge Private Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni server non sicure durante l'utilizzo di SSL.
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

Output

Se l'operazione va a buon fine, verrà visualizzato un output del token JST simile al seguente:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

Ispeziona un token JWT

Puoi ispezionare un token JWT con questo comando. Vedi anche Controllare un token.

Utilizzo

Per Edge Public Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
Per Edge Private Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni server non sicure durante l'utilizzo di SSL.
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

Output

Se l'operazione va a buon fine, visualizzerai un output simile al seguente:
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

Ruota un token JWT

Poco tempo dopo la generazione iniziale di un JWT, potrebbe essere necessario modificare la coppia di chiavi pubblica/privata archiviata da Apigee Edge nella sua mappa chiave-valore (KVM) criptata. Questo processo di generazione di una nuova coppia di chiavi è chiamato rotazione della chiave. Quando ruoti le chiavi, viene generata e archiviata una nuova coppia di chiavi privata/pubblica nel KVM "istio" dell'organizzazione/dell'ambiente Apigee Edge. Inoltre, la vecchia chiave pubblica viene mantenuta insieme al valore ID chiave originale.

Utilizzo

Se ti trovi in Edge Public Cloud:
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
Se ti trovi in Edge Private Cloud:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

Parametri

Parametri Tipo Descrizione
-c, --config Stringa (Obbligatorio) Il percorso del file di configurazione di Apigee Remote Service.
Suggerimento: questo flag consente di omettere la maggior parte degli altri parametri di comando, poiché l'interfaccia a riga di comando è in grado di eseguirne il pull direttamente dal file di configurazione. Consulta la sezione Utilizzo dell'opzione --config.
-e, --env Stringa (Obbligatorio) Un ambiente della tua organizzazione.
-h, --help Visualizza la guida per i parametri di comando.
--insecure Consenti connessioni a server non sicure durante l'utilizzo di SSL
--truncate int Numero di certificati da conservare nei file jwk (predefinito 2)
-o, --org Stringa (Obbligatorio) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r, --runtime Stringa (Solo Private Cloud) Specifica l'URL di runtime per la tua istanza Private Cloud.
-v, --verbose (Facoltativo) Genera un output dettagliato.

Esempio

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

Output

certificate successfully rotated

Utilizzo di .netrc per le credenziali

apigee-remote-service-cli preleva automaticamente username e password (per l'autenticazione di base, se necessaria) da un file .netrc nella tua home directory se ti trovi in Edge Public Cloud e hai una voce per la macchina api.enterprise.apigee.com. Se ti trovi in Apigee Private Cloud, il valore della macchina corrisponde all'URL di management (ad esempio: http://192.162.55.100). Ad esempio su Edge Public Cloud:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Ad esempio su Edge Private Cloud:
machine http://192.162.55.100
login jdoe@google.com
password abc123

Comando versione

Stampa la versione dell'interfaccia a riga di comando.

apigee-remote-service-cli version

Utilizzare l'opzione del comando --config

L'opzione --config specifica la posizione del file di configurazione generato dal comando provision. Un utile vantaggio di questa opzione è che consente di saltare la maggior parte degli altri parametri di comando, che l'interfaccia a riga di comando estrae dal file di configurazione. Queste opzioni includono:
  • organizzazione
  • ambiente
  • runtime
  • gestione
  • non sicuro
  • spazio dei nomi
  • legacy
  • opdk

Ad esempio, potresti eseguire il comando provision in questo modo:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

File di configurazione

Questa sezione mostra un file di configurazione di esempio con tutte le opzioni disponibili.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s