Référence

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

L'interface de ligne de commande (CLI) apigee-remote-service-cli vous aide à provisionner et à gérer Apigee Adapter for Envoy.

Commande pour répertorier les liaisons

Répertoriez tous les produits d'API associés au service distant.

Utilisation

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

Paramètres

Paramètres Présence Utilisé avec les produits Description
-c,
‑‑config 		Obligatoire Toutes (Chaîne) Chemin d'accès au fichier de configuration du service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-e,
‑‑environment 		Obligatoire Toutes (Chaîne) Un environnement dans votre organisation.
-h,
‑‑help 		Facultatif Toutes Affiche l'aide concernant les paramètres de commande.
‑‑insecure Facultatif Toutes Autorisez les connexions aux serveurs non sécurisées en cas d'utilisation de SSL.
‑‑legacy Obligatoire Cloud public Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud public. Définit les URL de gestion et d'exécution pour Apigee Edge pour le cloud public.
-m,
‑‑management 		Obligatoire Cloud privé Edge uniquement (Chaîne) URL de base de gestion de l'installation d'Apigee Edge pour Private Cloud. Valeur par défaut : https://api.enterprise.apigee.com
‑‑mfa Obligatoire Cloud public Edge uniquement (Chaîne) Jeton d'autorisation multifacteur pour votre Apigee Edge for Public Cloud. Obligatoire uniquement si la MFA est configurée sur votre compte Apigee Edge.
‑‑opdk Obligatoire Cloud privé Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud privé.
-o,
‑‑organization 		Obligatoire Toutes (Chaîne) Une organisation Apigee. Vous devez être un administrateur de l'entreprise.
-p,
‑‑password 		Obligatoire
(Authentification de base uniquement)		 Cloud public et privé Edge uniquement (Chaîne) Votre mot de passe Apigee. Vous pouvez éventuellement spécifier le mot de passe dans un fichier .netrc. Voir également Utiliser .netrc pour les identifiants.
-r,
‑‑runtime 		Obligatoire Cloud privé Edge et Apigee hybrid uniquement (Chaîne) Spécifie l'URL d'exécution de votre cloud privé ou instance Apigee hybrid. L'URL doit commencer par https://. Par exemple : https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Facultatif Cloud privé Edge uniquement (Chaîne) Spécifie le certificat TLS, la clé privée et l'autorité de certification racine côté client pour la connexion mTLS.
-t,
‑‑token 		Obligatoire
(authentification par jeton OAuth uniquement)		 Toutes (Chaîne) Jeton OAuth ou SAML généré à partir des informations de votre compte Apigee. Remplace tous les autres identifiants fournis.
-u,
‑‑username 		Obligatoire
(Authentification de base uniquement)		 Cloud public et privé Edge uniquement (Chaîne) Votre nom d'utilisateur Apigee (généralement une adresse e-mail). Vous pouvez éventuellement spécifier le nom d'utilisateur dans un fichier .netrc. Dans ce cas, vous n'êtes pas obligé de fournir votre nom d'utilisateur sur la ligne de commande. Voir également Utiliser .netrc pour les identifiants.
-v,
‑‑verbose 		Facultatif Toutes (Facultatif) Génère une sortie détaillée.

Exemple

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \
-c config.yaml -p abc123

Exemple de résultat : 

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:

Commande d'aide

L'aide en ligne est fournie pour toutes les commandes apigee-remote-service-cli. Il vous suffit de saisir :

apigee-remote-service-cli help

Pour obtenir de l'aide sur n'importe quelle commande, saisissez :

apigee-remote-service-cli [command] help

Exemple :

apigee-remote-service-cli provision help

Commande de provisionnement

La commande apigee-remote-service-cli provision installe deux proxys d'API dans votre organisation Apigee Edge, configure un certificat et génère des identifiants dont vous aurez besoin pour configurer Apigee Adapter for Envoy.

Utilisation

apigee-remote-service-cli provision [flags]

Paramètres

Paramètres Présence Utilisé avec les produits Description
‑‑analytics-sa Facultatif Apigee hybrid et Apigee X uniquement

(Chaîne) Utilisez cette option pour spécifier le chemin d'accès à un fichier de clé de compte de service Google Cloud, où le compte de service possède le rôle Apigee Analytics Agent. Le compte de service utilise l'adaptateur pour importer directement les données d'analyse dans Apigee. Si vous utilisez Apigee hybrid, cette option vous permet d'installer l'environnement d'exécution hybride dans un cluster et l'adaptateur dans un autre.
-c,
‑‑config 		Obligatoire Toutes (Chaîne) Chemin d'accès au fichier de configuration du service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-e,
‑‑environment 		Obligatoire Toutes (Chaîne) Un environnement dans votre organisation.
-f, ‑‑force-proxy-install Facultatif Toutes (Facultatif) Impose la réinstallation du proxy remote-service s'il est déjà installé dans votre organisation.
-h,
‑‑help 		Facultatif Toutes Affiche l'aide concernant les paramètres de commande.
‑‑insecure Facultatif Toutes Autorisez les connexions aux serveurs non sécurisées en cas d'utilisation de SSL.
‑‑legacy Obligatoire Cloud public Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud public. Définit les URL de gestion et d'exécution pour Apigee Edge pour le cloud public.
-m,
‑‑management 		Obligatoire Cloud privé Edge uniquement (Chaîne) URL de base de gestion de l'installation d'Apigee Edge pour Private Cloud. Valeur par défaut : https://api.enterprise.apigee.com
‑‑mfa Obligatoire Cloud public Edge uniquement Jeton d'autorisation multifacteur pour votre Apigee Edge pour Cloud public. Obligatoire uniquement si la MFA est configurée sur votre compte Apigee Edge.
-n, ‑‑namespace Facultatif Toutes (Chaîne) Exécuter la configuration en tant que ConfigMap Envoy dans l'espace de noms spécifié Valeur par défaut : apigee
‑‑opdk Obligatoire Cloud privé Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud privé.
-o,
‑‑organization 		Obligatoire Toutes (Chaîne) Une organisation Apigee. Vous devez être un administrateur de l'organisation pour pouvoir provisionner.
-p,
‑‑password 		Obligatoire
(Authentification de base uniquement)		 Cloud public et privé Edge uniquement (Chaîne) Votre mot de passe Apigee. Vous pouvez éventuellement spécifier le mot de passe dans un fichier
.netrc. Dans ce cas, vous n'êtes pas obligé de fournir votre mot de passe sur la ligne de commande. Consultez également la section Utiliser .netrc pour les identifiants.
‑‑rotate-int Facultatif Apigee hybrid uniquement (Entier) Si n > 0, générer une nouvelle clé privée et conserver n clés publiques (hybride uniquement)
-r,
‑‑runtime 		Obligatoire Cloud privé Edge et Apigee hybrid uniquement (Chaîne) Spécifie l'URL d'exécution de votre cloud privé ou instance Apigee hybrid. L'URL doit commencer par https://. Par exemple : https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Facultatif Cloud privé Edge uniquement (Chaîne) Spécifie le certificat TLS, la clé privée et l'autorité de certification racine côté client pour la connexion mTLS.
-t,
‑‑token 		Obligatoire
(authentification par jeton OAuth uniquement)		 Toutes (Chaîne) Jeton OAuth ou SAML généré à partir des informations de votre compte Apigee. Remplace tous les autres identifiants fournis.
-u,
‑‑username 		Obligatoire
(Authentification de base uniquement)		 Cloud public et privé Edge uniquement (Chaîne) Votre nom d'utilisateur Apigee (généralement une adresse e-mail). Vous pouvez éventuellement spécifier le nom d'utilisateur dans un fichier .netrc. Voir également Utiliser .netrc pour les identifiants.
-v,
‑‑verbose 		Facultatif Toutes (Facultatif) Génère une sortie détaillée.
‑‑virtual-hosts Facultatif Cloud privé Edge uniquement (Chaîne) Remplace les hôtes virtuels par défaut, qui sont default,secure. Utilisez cette option si vous avez spécifié des hôtes virtuels pour votre environnement d'organisation Edge autres que ceux par défaut.

Exemple

Comme le montre l'exemple suivant, il est important de capturer le résultat de la commande provision dans un fichier qui sera utilisé comme entrée pour d'autres opérations Apigee associées aux opérations Envoy.

Exemple : 

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

Commande d'exemples

Crée et affiche les exemples de fichiers de configuration.

Créer des exemples de fichiers de configuration

Crée des exemples de fichiers de configuration pour les déploiements Envoy et Istio natifs.

Utilisation

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

Description

Cette commande nécessite un fichier config.yaml valide en entrée. Ce fichier d'entrée est le fichier qui a été généré via le provisionnement. Par défaut, les exemples de fichiers sont générés dans un répertoire nommé ./samples. La commande crée ce répertoire pour vous.

Si vous utilisez le déploiement Envoy natif, la commande utilise l'hôte de service cible et le nom souhaité pour son cluster. Elle définit également une connexion SSL personnalisée entre le proxy Envoy et le cluster de services distants si un dossier contenant tls.key et tls.crt est fourni via --tls.

Si vous utilisez Istio, où le proxy Envoy sert de side-car, si la cible n'est pas spécifiée, l'exemple de httpbin est généré. Sinon, vous êtes responsable de la préparation des fichiers de configuration liés au déploiement de vos services cibles.

Paramètres

Paramètres Présence Utilisé avec les produits Description
‑‑adapter‑host Obligatoire pour les modèles Envoy uniquement Toutes (Chaîne) Nom d'hôte de l'adaptateur (par défaut : localhost)
-c, ‑‑config Obligatoire Toutes (Chaîne) Chemin d'accès au fichier de configuration du service de service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-f, ‑‑force Facultatif Toutes Forcez le remplacement du répertoire existant.
-h, ‑‑help Facultatif Toutes Affiche l'aide concernant les paramètres de commande.
‑‑host Obligatoire pour les modèles Envoy uniquement Toutes (Chaîne) Hôte du service cible (par défaut, httpbin.org)
-n, ‑‑name Obligatoire Toutes (Chaîne) Nom du service cible (par défaut httpbin.org)
‑‑out Facultatif Toutes (Chaîne) Répertoire dans lequel créer les exemples de fichiers de configuration.
Par défaut : ./samples
‑‑tag Obligatoire pour les modèles Istio uniquement Toutes (Chaîne) Tag de version de l'image d'adaptateur Envoy. Valeur par défaut : v2.0.0
-t, ‑‑template Obligatoire Toutes (Chaîne) Nom du modèle Envoy ou Istio. Pour afficher la liste des modèles disponibles, exécutez la commande apigee-remote-service samples templates.
‑‑tls Facultatif, pour les modèles Envoy seulement Toutes (Chaîne) Répertoire contenant les fichiers tls.key et tls.crt utilisés pour le service de l'adaptateur.

Exemple 

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

Répertorier les options de modèle disponibles

Répertorie les modèles disponibles à utiliser avec le paramètre --templates pour la commande samples.

Utilisation

apigee-remote-service-cli samples templates

Paramètres

Aucun

Exemple 

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

Commandes de jetons

Vous pouvez utiliser un jeton JWT pour effectuer des appels de proxy d'API authentifiés au lieu d'utiliser une clé API. Les commandes de jeton vous permettent de créer, d'inspecter et d'alterner des jetons JWT à cette fin.

Créer un jeton JWT

Vous pouvez utiliser un jeton JWT pour effectuer des appels de proxy d'API authentifiés à une cible de service distant. Voir également Utiliser l'authentification basée sur JWT.

Utilisation

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

Paramètres

Paramètres Présence Utilisé avec les produits Description
-c,
‑‑config 		Obligatoire Toutes (Chaîne) Chemin d'accès au fichier de configuration du service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-e,
‑‑environment 		Obligatoire Toutes (Chaîne) Un environnement dans votre organisation.
-h,
‑‑help 		Facultatif Toutes Affiche l'aide concernant les paramètres de commande.
--i, --id Obligatoire Toutes (Chaîne) Identifiant Clé trouvé dans l'application de développement Apigee, comme décrit dans la section Comment obtenir une clé API.
‑‑insecure Facultatif Toutes Autorisez les connexions aux serveurs non sécurisées en cas d'utilisation de SSL.
‑‑legacy Obligatoire Cloud public Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud public. Définit les URL de gestion et d'exécution pour Apigee Edge pour le cloud public.
‑‑opdk Obligatoire Cloud privé Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud privé.
-o,
‑‑organization 		Obligatoire Toutes (Chaîne) Une organisation Apigee. Vous devez être un administrateur de l'entreprise.
-r,
‑‑runtime 		Obligatoire Cloud privé Edge et Apigee hybrid uniquement (Chaîne) Spécifie l'URL d'exécution de votre cloud privé ou instance Apigee hybrid. L'URL doit commencer par https://. Par exemple : https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Obligatoire Toutes (Chaîne) Identifiant Secret trouvé dans l'application de développement Apigee, comme décrit dans la section Comment obtenir une clé API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Facultatif Cloud privé Edge uniquement (Chaîne) Spécifie le certificat TLS, la clé privée et l'autorité de certification racine côté client pour la connexion mTLS.
-v,
‑‑verbose 		Facultatif Toutes (Facultatif) Génère une sortie détaillée.

Exemple

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

Sortie

Si l'opération réussit, un résultat de jeton JST semblable à celui-ci s'affiche : 
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

Inspecter un jeton JWT

Cette commande vous permet d'inspecter un jeton JWT. Voir également Inspecter un jeton.

Utilisation

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

Paramètres

Paramètres

Paramètres Présence Utilisé avec les produits Description
-c,
‑‑config 		Obligatoire Toutes (Chaîne) Chemin d'accès au fichier de configuration du service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-e,
‑‑environment 		Obligatoire Toutes (Chaîne) Un environnement dans votre organisation.
-f,
‑‑file 		Obligatoire Toutes (Chaîne) Le fichier de jeton (par défaut : utiliser stdin)
-h,
‑‑help 		Facultatif Toutes Affiche l'aide concernant les paramètres de commande.
‑‑insecure Facultatif Toutes Autorisez les connexions aux serveurs non sécurisées en cas d'utilisation de SSL.
‑‑legacy Obligatoire Cloud public Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud public. Définit les URL de gestion et d'exécution pour Apigee Edge pour le cloud public.
‑‑opdk Obligatoire Cloud privé Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud privé.
-o,
‑‑organization 		Obligatoire Toutes (Chaîne) Une organisation Apigee. Vous devez être un administrateur de l'entreprise.
-r,
‑‑runtime 		Obligatoire Cloud privé Edge et Apigee hybrid uniquement (Chaîne) Spécifie l'URL d'exécution de votre cloud privé ou instance Apigee hybrid. L'URL doit commencer par https://. Par exemple : https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Facultatif Cloud privé Edge uniquement (Chaîne) Spécifie le certificat TLS, la clé privée et l'autorité de certification racine côté client pour la connexion mTLS.
-v,
‑‑verbose 		Facultatif Toutes (Facultatif) Génère une sortie détaillée.

Exemple

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

Sortie

Si l'opération réussit, un résultat semblable à celui-ci s'affiche : 
{
	"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.

Effectuer une rotation de jeton JWT

Après la génération initiale d'un jeton JWT, vous pouvez être amené à modifier la paire de clés publique/privée stockée par Apigee dans son mappage clés-valeurs chiffrées (KVM). Ce processus de génération d'une nouvelle paire de clés est appelé rotation des clés. Lorsque vous effectuez une rotation des clés, une nouvelle paire de clés privée/publique est générée et stockée dans la KVM "Istio" de votre organisation/environnement Apigee. De plus, l'ancienne clé publique est conservée avec son ID de clé d'origine.

Utilisation

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

Paramètres

Paramètres Présence Utilisé avec les produits Description
-c,
‑‑config 		Obligatoire Toutes (Chaîne) Chemin d'accès au fichier de configuration du service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-e,
‑‑environment 		Obligatoire Toutes (Chaîne) Un environnement dans votre organisation.
-h,
‑‑help 		Facultatif Cloud public et privé Edge uniquement Affiche l'aide concernant les paramètres de commande.
--k, --key Obligatoire Cloud public et privé Edge uniquement (Chaîne) La clé de provisionnement.
‑‑insecure Facultatif Cloud public et privé Edge uniquement Autorisez les connexions aux serveurs non sécurisées en cas d'utilisation de SSL.
‑‑legacy Obligatoire Cloud public Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud public. Définit les URL de gestion et d'exécution pour Apigee Edge pour le cloud public.
‑‑opdk Obligatoire Cloud privé Edge uniquement Vous devez définir cette option si vous utilisez Apigee Edge pour le cloud privé.
-o,
‑‑organization 		Obligatoire Cloud public et privé Edge uniquement (Chaîne) Une organisation Apigee. Vous devez être un administrateur de l'entreprise.
-r,
‑‑runtime 		Obligatoire Cloud privé Edge uniquement (Chaîne) Spécifie l'URL d'exécution de votre cloud privé ou instance Apigee hybrid. L'URL doit commencer par https://. Par exemple : https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Obligatoire Toutes (Chaîne) Le code secret de la provision
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Facultatif Cloud privé Edge uniquement (Chaîne) Spécifie le certificat TLS, la clé privée et l'autorité de certification racine côté client pour la connexion mTLS.
--t, ‑‑truncate Obligatoire Toutes (Entier) Nombre de certificats à conserver dans JWKS (valeur par défaut : 2).
-v,
‑‑verbose 		Facultatif Toutes (Facultatif) Génère une sortie détaillée.

Exemple

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

Sortie

certificate successfully rotated

Créer un jeton interne

Créez un jeton JWT pour autoriser les appels d'API de service distant.

Utilisation

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

Paramètres

Paramètres

Paramètres Présence Utilisé avec les produits Description
-c,
‑‑config 		Obligatoire Apigee hybrid uniquement (Chaîne) Chemin d'accès au fichier de configuration du service distant Apigee.
Conseil : Cette option vous permet d'omettre la plupart des autres paramètres de commande, car la CLI peut les extraire directement du fichier de configuration. Consultez la section Utiliser l'option ‑‑config.
-d,
‑‑duration 		Obligatoire Apigee hybrid uniquement (Chaîne) Heure valide du JWT interne à partir de la création (par défaut : 10m0s (10 minutes)).
-e,
‑‑environment 		Requis Apigee hybrid uniquement (Chaîne) Un environnement dans votre organisation.
-h,
‑‑help 		Facultatif Apigee hybrid uniquement Affiche l'aide concernant les paramètres de commande.
‑‑insecure Facultatif Apigee hybrid uniquement Autorisez les connexions aux serveurs non sécurisées en cas d'utilisation de SSL.
-o,
‑‑organization 		Obligatoire Apigee hybrid uniquement (Chaîne) Une organisation Apigee. Vous devez être un administrateur de l'entreprise.
-r,
‑‑runtime 		Obligatoire Apigee hybrid uniquement (Chaîne) Spécifie l'URL d'exécution de votre instance Apigee hybrid. L'URL doit commencer par https://. Par exemple : https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		Facultatif Apigee hybrid uniquement (Facultatif) Génère une sortie détaillée.

Commande de version

Imprime la version de la CLI.

apigee-remote-service-cli version

Utiliser .netrc pour les identifiants

apigee-remote-service-cli récupère automatiquement les éléments username et password (pour l'authentification de base si nécessaire) dans un fichier .netrc de votre répertoire d'accueil si vous utilisez le cloud public Edge et que vous disposez d'une entrée pour la machine api.enterprise.apigee.com. Si vous utilisez un cloud privé Apigee, la valeur de la machine est identique à votre URL management (par exemple : http://192.162.55.100). Par exemple sur Edge Public Cloud :
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Par exemple sur le cloud privé Edge :
machine http://192.162.55.100
login jdoe@google.com
password abc123

En utilisant l'option de commande ‑‑config

L'option ‑‑config spécifie l'emplacement du fichier de configuration généré par la commande provision. L'avantage pratique de cette option est qu'elle vous permet d'ignorer la plupart des autres paramètres de commande que la CLI extrait du fichier de configuration. Vous disposez des options suivantes :
  • organisation
  • Environnement
  • runtime
  • gestion
  • Incertain
  • namespace
  • ancien
  • Opdk

Par exemple, vous pouvez exécuter la commande provision comme suit: 

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

Fichier de configuration

Cette section présente un exemple de fichier de configuration avec toutes les options disponibles. 

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