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.

Comando Elenca associazioni

Elenca tutti i prodotti API associati al servizio remoto.

Utilizzo

apigee-remote-service-cli bindings list [flags]

Parametri

Parametri Presenza Utilizzato con i prodotti Descrizione
-c,
‑‑config
Obbligatorie Tutte (Stringa) 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,
‑‑environment
Obbligatorie Tutte (Stringa) Un ambiente della tua organizzazione.
-h,
‑‑help
Facoltativo Tutte Visualizza la guida per i parametri di comando.
‑‑insecure Facoltativo Tutte Consenti connessioni server non sicure durante l'utilizzo di SSL.
‑‑legacy Obbligatorie Solo cloud pubblico perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud pubblico. Imposta gli URL di gestione e runtime per Apigee Edge per il cloud pubblico.
-m,
‑‑management
Obbligatorie Solo Cloud privato perimetrale (Stringa) L'URL di gestione di base per l'installazione di Apigee Edge per il cloud privato. URL predefinito: https://api.enterprise.apigee.com
‑‑mfa Obbligatorie Solo cloud pubblico perimetrale (Stringa) Token di autorizzazione a più fattori per Apigee Edge per il cloud pubblico. Obbligatorio solo se MFA è configurata sul tuo account Apigee Edge.
‑‑opdk Obbligatorie Solo Cloud privato perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud privato.
-o,
‑‑organization
Obbligatorie Tutte (Stringa) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-p,
‑‑password
Obbligatoria
(solo autenticazione di base)
Solo cloud pubblico e privato perimetrale (Stringa) La password di Apigee. Facoltativamente, puoi specificare la password in un file .netrc. Vedi anche Utilizzo di .netrc per le credenziali.
-r,
‑‑runtime
Obbligatorie Solo Edge Private Cloud e Apigee hybrid (Stringa) Specifica l'URL di runtime per la tua istanza Private Cloud o Apigee ibrida. L'URL deve iniziare con https://. Ad esempio: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Facoltativo Solo Cloud privato perimetrale (Stringa) Specifica il certificato TLS lato client, la chiave privata e la CA radice per la connessione mTLS.
-t,
‑‑token
Obbligatorio
(solo autenticazione token OAuth)
Tutte (Stringa) Un token OAuth o SAML che viene generato dai dati dell'account Apigee. Esegue l'override di qualsiasi altra credenziale fornita.
-u,
‑‑username
Obbligatoria
(solo autenticazione di base)
Solo cloud pubblico e privato perimetrale (Stringa) 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 Tutte (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

Output di esempio

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:

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 due proxy API nella tua organizzazione Apigee Edge, configura un certificato e genera le credenziali necessarie per configurare Apigee Adapter for Envoy.

Utilizzo

apigee-remote-service-cli provision [flags]

Parametri

Parametri Presenza Utilizzato con i prodotti Descrizione
‑‑analytics-sa Facoltativo Solo Apigee hybrid e Apigee X

(Stringa) 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
Obbligatorie Tutte (Stringa) 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,
‑‑environment
Obbligatorie Tutte (Stringa) Un ambiente della tua organizzazione.
-f, ‑‑force-proxy-install Facoltativo Tutte (Facoltativo) Forza la reinstallazione del proxy remote-service se è già installato nella tua organizzazione.
-h,
‑‑help
Facoltativo Tutte Visualizza la guida per i parametri di comando.
‑‑insecure Facoltativo Tutte Consenti connessioni server non sicure durante l'utilizzo di SSL.
‑‑legacy Obbligatorie Solo cloud pubblico perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud pubblico. Imposta gli URL di gestione e runtime per Apigee Edge per il cloud pubblico.
-m,
‑‑management
Obbligatorie Solo Cloud privato perimetrale (Stringa) L'URL di gestione di base per l'installazione di Apigee Edge per il cloud privato. URL predefinito: https://api.enterprise.apigee.com
‑‑mfa Obbligatorie Solo cloud pubblico perimetrale Token di autorizzazione a più fattori per Apigee Edge per il cloud pubblico. Obbligatorio solo se MFA è configurata sul tuo account Apigee Edge.
-n, ‑‑namespace Facoltativo Tutte (Stringa) Emette la configurazione come ConfigMap Envoy nello spazio dei nomi specificato. URL predefinito: apigee
‑‑opdk Obbligatorie Solo Cloud privato perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud privato.
-o,
‑‑organization
Obbligatorie Tutte (Stringa) Un'organizzazione Apigee. Per eseguire il provisioning devi essere un amministratore dell'organizzazione.
-p,
‑‑password
Obbligatoria
(solo autenticazione di base)
Solo cloud pubblico e privato perimetrale (Stringa) La password di 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 Facoltativo Solo Apigee hybrid (Numero intero) Se n > 0, genera una nuova chiave privata e mantieni n chiavi pubbliche (solo ibrido)
-r,
‑‑runtime
Obbligatorie Solo Edge Private Cloud e Apigee hybrid (Stringa) Specifica l'URL di runtime per la tua istanza Private Cloud o Apigee ibrida. L'URL deve iniziare con https://. Ad esempio: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Facoltativo Solo Cloud privato perimetrale (Stringa) Specifica il certificato TLS lato client, la chiave privata e la CA radice per la connessione mTLS.
-t,
‑‑token
Obbligatorio
(solo autenticazione token OAuth)
Tutte (Stringa) Un token OAuth o SAML che viene generato dai dati dell'account Apigee. Esegue l'override di qualsiasi altra credenziale fornita.
-u,
‑‑username
Obbligatoria
(solo autenticazione di base)
Solo cloud pubblico e privato perimetrale (Stringa) 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 Tutte (Facoltativo) Genera un output dettagliato.
‑‑virtual-hosts Facoltativo Solo Cloud privato perimetrale (Stringa) Sostituisce gli 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.

Esempio

Come mostra l'esempio seguente, è importante acquisire l'output del comando provision in un file, che viene utilizzato come input per altre operazioni di Apigee Adapter for Envoy.

Esempio:

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

Comando Samples

Crea ed elenca file di configurazione di esempio.

Creare file di configurazione di esempio

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

Utilizzo

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

Descrizione

Questo comando richiede un file config.yaml valido come input. Questo file di input è il file 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 Presenza Utilizzato con i prodotti Descrizione
‑‑adapter‑host Obbligatorio solo per i modelli Envoy Tutte (Stringa) Il nome host dell'adattatore (valore predefinito: localhost)
-c, ‑‑config Obbligatorie Tutte (Stringa) Percorso del file di configurazione del servizio remoto Apigee.
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 Facoltativo Tutte Forza la sovrascrittura della directory esistente.
-h, ‑‑help Facoltativo Tutte Visualizza la guida per i parametri di comando.
‑‑host Obbligatorio solo per i modelli Envoy Tutte (Stringa) L'host del servizio di destinazione (valore predefinito httpbin.org)
-n, ‑‑name Obbligatorie Tutte (Stringa) Il nome del servizio di destinazione (valore predefinito httpbin.org)
‑‑out Facoltativo Tutte (Stringa) La directory in cui creare i file di configurazione di esempio.
Predefinito: ./samples
‑‑tag Obbligatorio solo per i modelli Istio Tutte (Stringa) Il tag di versione dell'immagine Envoy Adapter. URL predefinito: v2.0.0
-t, ‑‑template Obbligatorie Tutte (Stringa) Il nome del modello Envoy o Istio. Per visualizzare l'elenco di modelli disponibili, esegui il comando apigee-remote-service samples templates.
‑‑tls Facoltativo, solo per modelli Envoy Tutte (Stringa) La directory contenente i file tls.key e tls.crt utilizzati per il servizio dell'adattatore.

Esempio

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

Elenca opzioni disponibili per i modelli

Elenca i modelli che è possibile utilizzare con il parametro --templates per il comando samples.

Utilizzo

apigee-remote-service-cli samples templates

Parametri

Nessuna.

Esempio

apigee-remote-service-cli samples templates
Supported templates (native is deprecated):
  envoy-1.15
  envoy-1.16
  envoy-1.17
  istio-1.7
  istio-1.8
  istio-1.9

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

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

Parametri

Parametri Presenza Utilizzato con i prodotti Descrizione
-c,
‑‑config
Obbligatorie Tutte (Stringa) 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,
‑‑environment
Obbligatorie Tutte (Stringa) Un ambiente della tua organizzazione.
-h,
‑‑help
Facoltativo Tutte Visualizza la guida per i parametri di comando.
--i, --id Obbligatorie Tutte (Stringa) La credenziale Chiave trovata nell'app per sviluppatori Apigee come descritto in Come ottenere una chiave API.
‑‑insecure Facoltativo Tutte Consenti connessioni server non sicure durante l'utilizzo di SSL.
‑‑legacy Obbligatorie Solo cloud pubblico perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud pubblico. Imposta gli URL di gestione e runtime per Apigee Edge per il cloud pubblico.
‑‑opdk Obbligatorie Solo Cloud privato perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud privato.
-o,
‑‑organization
Obbligatorie Tutte (Stringa) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r,
‑‑runtime
Obbligatorie Solo Edge Private Cloud e Apigee hybrid (Stringa) Specifica l'URL di runtime per la tua istanza Private Cloud o Apigee ibrida. L'URL deve iniziare con https://. Ad esempio: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Obbligatorie Tutte (Stringa) La credenziale Secret trovata nell'app per sviluppatori Apigee come descritto in Come ottenere una chiave API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Facoltativo Solo Cloud privato perimetrale (Stringa) Specifica il certificato TLS lato client, la chiave privata e la CA radice per la connessione mTLS.
-v,
‑‑verbose
Facoltativo Tutte (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

apigee-remote-service-cli token inspect [flags]

Parametri

Parametri

Parametri Presenza Utilizzato con i prodotti Descrizione
-c,
‑‑config
Obbligatorie Tutte (Stringa) 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,
‑‑environment
Obbligatorie Tutte (Stringa) Un ambiente della tua organizzazione.
-f,
‑‑file
Obbligatorie Tutte (Stringa) Il file token (impostazione predefinita: utilizza stdin)
-h,
‑‑help
Facoltativo Tutte Visualizza la guida per i parametri di comando.
‑‑insecure Facoltativo Tutte Consenti connessioni server non sicure durante l'utilizzo di SSL.
‑‑legacy Obbligatorie Solo cloud pubblico perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud pubblico. Imposta gli URL di gestione e runtime per Apigee Edge per il cloud pubblico.
‑‑opdk Obbligatorie Solo Cloud privato perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud privato.
-o,
‑‑organization
Obbligatorie Tutte (Stringa) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r,
‑‑runtime
Obbligatorie Solo Edge Private Cloud e Apigee hybrid (Stringa) Specifica l'URL di runtime per la tua istanza Private Cloud o Apigee ibrida. L'URL deve iniziare con https://. Ad esempio: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Facoltativo Solo Cloud privato perimetrale (Stringa) Specifica il certificato TLS lato client, la chiave privata e la CA radice per la connessione mTLS.
-v,
‑‑verbose
Facoltativo Tutte (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 nella sua mappa chiave-valore criptata (KVM). 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" nell'organizzazione/nell'ambiente Apigee. Inoltre, la vecchia chiave pubblica viene mantenuta insieme al valore ID chiave originale.

Utilizzo

apigee-remote-service-cli token rotate-cert [flags]

Parametri

Parametri Presenza Utilizzato con i prodotti Descrizione
-c,
‑‑config
Obbligatorie Tutte (Stringa) 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,
‑‑environment
Obbligatorie Tutte (Stringa) Un ambiente della tua organizzazione.
-h,
‑‑help
Facoltativo Solo cloud pubblico e privato perimetrale Visualizza la guida per i parametri di comando.
--k, --key Obbligatorie Solo cloud pubblico e privato perimetrale (Stringa) La chiave di provisioning.
‑‑insecure Facoltativo Solo cloud pubblico e privato perimetrale Consenti connessioni server non sicure durante l'utilizzo di SSL.
‑‑legacy Obbligatorie Solo cloud pubblico perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud pubblico. Imposta gli URL di gestione e runtime per Apigee Edge per il cloud pubblico.
‑‑opdk Obbligatorie Solo Cloud privato perimetrale Devi impostare questo flag se utilizzi Apigee Edge per il cloud privato.
-o,
‑‑organization
Obbligatorie Solo cloud pubblico e privato perimetrale (Stringa) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r,
‑‑runtime
Obbligatorie Solo Cloud privato perimetrale (Stringa) Specifica l'URL di runtime per la tua istanza Private Cloud o Apigee ibrida. L'URL deve iniziare con https://. Ad esempio: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Obbligatorie Tutte (Stringa) Il secret di provisioning.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Facoltativo Solo Cloud privato perimetrale (Stringa) Specifica il certificato TLS lato client, la chiave privata e la CA radice per la connessione mTLS.
--t, ‑‑truncate Obbligatorie Tutte (Numero intero) Il numero di certificati da conservare in JWKS (valore predefinito: 2).
-v,
‑‑verbose
Facoltativo Tutte (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

Crea un token interno

Crea un token JWT per autorizzare le chiamate API per i servizi remoti.

Utilizzo

apigee-remote-service-cli token internal [flags]

Parametri

Parametri

Parametri Presenza Utilizzato con i prodotti Descrizione
-c,
‑‑config
Obbligatorie Solo Apigee hybrid (Stringa) 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.
-d,
‑‑duration
Obbligatorie Solo Apigee hybrid (Stringa) tempo valido del JWT interno dalla creazione (valore predefinito: 10m0s (10 minuti)).
-e,
‑‑environment
Obbligatorie Solo Apigee hybrid (Stringa) Un ambiente della tua organizzazione.
-h,
‑‑help
Facoltativo Solo Apigee hybrid Visualizza la guida per i parametri di comando.
‑‑insecure Facoltativo Solo Apigee hybrid Consenti connessioni server non sicure durante l'utilizzo di SSL.
-o,
‑‑organization
Obbligatorie Solo Apigee hybrid (Stringa) Un'organizzazione Apigee. Devi essere un amministratore dell'organizzazione.
-r,
‑‑runtime
Obbligatorie Solo Apigee hybrid (Stringa) Specifica l'URL di runtime per l'istanza ibrida Apigee. L'URL deve iniziare con https://. Ad esempio: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose
Facoltativo Solo Apigee hybrid (Facoltativo) Genera un output dettagliato.

Comando versione

Stampa la versione dell'interfaccia a riga di comando.

apigee-remote-service-cli version

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

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
  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
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_header: :authority
  allow_unauthorized: false
  jwt_provider_key: https://org-test.apigee.net/remote-token/token
  append_metadata_headers: true