Başvuru Kaynakları

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
bilgi

apigee-remote-service-cli Komut Satırı Arayüzü (KSA) sayesinde Envoy için Apigee Adapter'ı hazırlama ve yönetme.

Bağlama komutları

Bağlama işlemi, Istio ağına dağıtılan bir hizmeti bir Apigee API ürünüyle ilişkilendirir. KSA, bağlantıları listelemenize ve doğrulamanıza olanak tanır.

Bağlantıları listeleyin

Uzak Hizmet'e bağlı tüm API ürünlerini listeleyin.

Kullanım

Edge Herkese Açık Bulut için:

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

Edge Private Cloud için:

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

Parametreler

Parametreler Tür Açıklama
-c, --config Dize (Gerekli) Apigee Remote Service yapılandırma dosyasının yolu.
. İpucu: Bu işaret, diğer komut parametrelerini atlamanıza olanak tanır çünkü CLI, bunları doğrudan yapılandırma dosyasından alabilir. Bkz. --config seçeneği kullanılıyor..
-e, --env Dize (Zorunlu) Kuruluşunuzdaki bir ortam.
-h, --help Komut parametreleriyle ilgili yardımı görüntüler.
--insecure SSL kullanırken güvenli olmayan sunucu bağlantılarına izin ver
--legacy Apigee Edge Cloud kullanıyorsanız bu işareti ayarlayın. Yönetim ve çalışma zamanı URL'lerini ayarlar .
--mfa Apigee çok öğeli yetkilendirme jetonu (yalnızca --legacy ile kullanılır)
--opdk Private Cloud için Apigee Edge kullanıyorsanız bu işareti ayarlayın.
-o, --org Dize (Zorunlu) Bir Apigee kuruluşu. Kuruluş yöneticisi olmanız gerekir.
-p, --password Dize (Yalnızca temel kimlik doğrulaması için gereklidir) Apigee şifreniz. İsteğe bağlı olarak, şifreyi .netrc dosyasında da kullanabilirsiniz. Aksi takdirde komut satırında şifrenizi girin. Şu kaynakları da inceleyin Kimlik bilgileri için .netrc dosyasını kullanma.
-r, --runtime Dize (Yalnızca Private Cloud) Private Cloud örneğinizin çalışma zamanı URL'sini belirtir.
-t, --token Dize (Yalnızca OAuth jetonu kimlik doğrulaması için gereklidir) Oluşturduğunuz bir OAuth veya SAML jetonu otomatik olarak oluşturabilirsiniz. Jeton oluşturma hakkında bilgi için bkz. get_token ve Manage API'ye SAML ile erişin.
-u, --username Dize (Yalnızca temel kimlik doğrulama için gereklidir) Apigee kullanıcı adınız (genellikle bir e-posta adresi). İsterseniz kullanıcı adını bir .netrc dosyasında belirtebilirsiniz. Bunu yapmanız halinde, komut satırında kullanıcı adınızı girmeniz gerekmez. Görüntüleyin Ayrıca Kimlik bilgileri için .netrc yöntemini kullanma.
-v, --verbose (İsteğe bağlı) Ayrıntılı çıkış üretir.

Örnek

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:

Bağlamayı doğrulama

Bu komut kullanımdan kaldırıldı. 1.4 sürümünde, geliştirici uygulamaları için artık uzak hizmet hedefleriyle kullanılan API ürünleriyle bir ilişkilendirme.

Yardım komutu

Tüm apigee-remote-service-cli komutları için çevrimiçi yardım sağlanır. Şunları yazmanız yeterlidir:

apigee-remote-service-cli help

Herhangi bir komutla ilgili yardım almak için şunu yazın:

apigee-remote-service-cli [command] help

Örneğin:

apigee-remote-service-cli provision help

Temel hazırlık komutu

apigee-remote-service-cli provision komutu Apigee'nize bir proxy yükler Edge organizasyonu, sertifika ayarlar ve şunları yapmanız gereken kimlik bilgileri oluşturur: Envoy için Apigee Adapter'ı yapılandırın.

Kullanım

Edge Public Cloud kullanıyorsanız:

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

Edge Private Cloud kullanıyorsanız:

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

Parametreler

Parametreler Tür Açıklama
--analytics-sa Dize Bu işaret yalnızca Google Cloud kurulumlarında Apigee hybrid ve Apigee için kullanılabilir.

Google Cloud hizmet hesabı anahtar dosyasının yolunu belirtmek için bu işareti kullanın; burada hizmet hesabı Apigee Analytics Agent rolüne sahip. SA, bağdaştırıcıyı kullanarak analiz verilerini doğrudan Apigee'ye yükleyebilir. Apigee hybrid kullanıyorsanız Bu seçenek karma çalışma zamanını bir kümeye yüklemenize ve bağdaştırıcıyı da olduğunu varsayalım.

-c, --config Dize Apigee Remote Service yapılandırma dosyasının yolu. Şu kaynakları da inceleyin: --config seçeneğini kullanma.
-e, --environment Dize (Zorunlu) Kuruluşunuzdaki bir ortam.
-f, --force-proxy-install (İsteğe bağlı) remote-service proxy'sinin yeniden yüklenmesini zorunlu kılar kuruluşunuzda zaten yüklü.
-h, --help Komut parametreleriyle ilgili yardımı görüntüler.
-k, --key Dize Döndürülen anahtarı belirtir apigee-remote-service-cli provision komutunu kullanın.
--legacy Apigee Edge Cloud kullanıyorsanız bu işareti ayarlayın. Yönetim ve çalışma zamanı URL'lerini ayarlar .
--mfa Apigee çok öğeli yetkilendirme jetonu (yalnızca --legacy ile kullanılır)
-m, --management Dize (Apigee Private Cloud kullanıyorsanız gereklidir) Apigee yönetim temel URL'niz. Varsayılan: https://api.enterprise.apigee.com
-n, --namespace Dize Yapılandırmayı, belirtilen ad alanında bir Envoy ConfigMap olarak yayınlayın. Varsayılan: Apigee
--opdk Dize Apigee OPDK.
-o, --organization Dize (Zorunlu) Apigee kuruluşunuz. Kuruluş yöneticisi olmanız gerekir.
-p, --password Dize (Yalnızca temel kimlik doğrulaması için gereklidir) Apigee şifreniz. İsteğe bağlı olarak, şifreyi .netrc dosyasında da kullanabilirsiniz. Aksi takdirde komut satırında şifrenizi girin. Şu kaynakları da inceleyin Kimlik bilgileri için .netrc dosyasını kullanma.
--rotate-int int n ise > 0, yeni özel anahtar oluşturun ve n ortak anahtarı saklayın (yalnızca karma)
-r, --runtime Dize (Yalnızca Private Cloud) Private Cloud örneğinizin çalışma zamanı URL'sini belirtir.
-s, --secret Dize apigee-remote-service-cli provision öğesinden döndürülen gizli anahtarı belirtir komutuna ekleyin.
--strength int (İsteğe bağlı) adaptörü kullanabilirsiniz. Varsayılan 2048
-t, --token Dize (Yalnızca karma) Apigee OAuth veya SAML jetonu.
-u, --username Dize (Yalnızca temel kimlik doğrulama için gereklidir) Apigee kullanıcı adınız (genellikle bir e-posta adresi). İsterseniz kullanıcı adını bir .netrc dosyasında belirtebilirsiniz. Ayrıca bkz. Kimlik bilgileri için .netrc'ü kullanma.
-v, --verbose (İsteğe bağlı) Ayrıntılı çıkış üretir.
--virtual-hosts Dize default,secure olan varsayılan sanal ana makineleri geçersiz kılar. Aşağıdaki durumlarda bu seçeneği kullanın: Edge kuruluş ortamınız için bu varsayılanlar dışında sanal ana makinelere sahip olmanız gerekir. Öğrenmek için Edge belgelerini inceleyin sanal ana makineler hakkında
--years int (İsteğe bağlı) Temel hazırlıkta kullanılan SSL sertifikasından önceki yıl sayısı sona erecektir. Varsayılan: 1

Örnek

provision komutunun çıkışını, kullanılan bir dosya için yakaladığınızdan emin olun. Bu, Envoy için diğer Apigee Adapter for Envoy işlemleri için girdi olarak kullanılabilir.

Edge Genel Bulut örneği:

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

Sana Özel komutu

Yerel Envoy veya Istio dağıtımları için örnek yapılandırma dosyaları oluşturur.

Kullanım

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

Açıklama

Komut, temel hazırlık aracılığıyla oluşturulmuş geçerli bir config.yaml dosyası gerektirir. Varsayılan olarak örnek dosyaların çıkışları ./samples adlı bir dizine gönderilir. Komut sizin için bu dizini oluşturur.

Yerel Envoy kullanıyorsanız komut, hedef hizmet ana makinesini ve kümesidir. Ayrıca Envoy proxy'sinden uzak hizmete olan özel SSL bağlantısını ayarlar kümeyi tls.key ve tls.crt içeren bir klasör --tls aracılığıyla sağlanırsa kümeyi yeniden açabilir.

Hedef belirtilmemişse Envoy proxy'sinin yardımcı dosya görevi gördüğü Istio'yu kullanıyorsanız httpbin örneği oluşturulur. Aksi takdirde hedef hizmetlerinizin dağıtımıyla ilgili yapılandırma dosyaları.

Parametreler

Parametreler Tür Açıklama
-c, --config Dize (Gerekli) Apigee Remote Service yapılandırma dosyasının yolu.
. İpucu: Bu işaret, diğer komut parametrelerini atlamanıza olanak tanır çünkü CLI, bunları doğrudan yapılandırma dosyasından alabilir. Bkz. --config seçeneğini kullanma.
-f, --force Mevcut dizinin üzerine yazılmaya zorlayın.
-h, --help Komut parametreleriyle ilgili yardımı görüntüler.
--host Hedef hizmet ana makinesi (varsayılan "httpbin.org")
-n, --name Hedef hizmet adı (varsayılan "httpbin")
--out Örnek yapılandırma dosyalarının oluşturulacağı dizin. Varsayılan: ./samples
-t, --template

Şablonun adı. Istio dağıtımı (yalnızca karma) yapıyorsanız kullanılabilir Istio seçenekleri vardır. Yerel Envoy dağıtımları için yerel seçeneği kullanın. Kullanılabilir seçenekler şunlardır:

  • istio-1.6 (Varsayılan)
  • istio-1.7
  • native
--tls TLS anahtarı ve crt dosyalarının depolanacağı dizin.

Örnek

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

Kullanılabilir şablon seçeneklerini listele

--templates parametresiyle kullanılabilecek seçenekleri listeler.

Kullanım

apigee-remote-service-cli samples templates

Parametreler

Yok.

Örnek

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

Jeton komutları

Kimliği doğrulanmış API proxy çağrıları yapmak için API anahtarı kullanmak yerine JWT jetonu kullanabilirsiniz. Jeton komutları, bu amaçla JWT jetonları oluşturmanıza, incelemenize ve değiştirmenize olanak tanır.

JWT jetonu oluşturun

Uzak bir hizmet hedefine kimliği doğrulanmış API proxy çağrıları yapmak için bir JWT jetonu kullanabilirsiniz. Görüntüleyin Ayrıca JWT tabanlı kimlik doğrulama kullanma.

Kullanım

Edge Herkese Açık Bulut için:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
Edge Private Cloud için:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

Parametreler

Parametreler Tür Açıklama
-c, --config Dize (Gerekli) Apigee Remote Service yapılandırma dosyasının yolu.
. İpucu: Bu işaret, diğer komut parametrelerini atlamanıza olanak tanır çünkü CLI, bunları doğrudan yapılandırma dosyasından alabilir. Bkz. --config seçeneğini kullanma.
-e, --env Dize (Zorunlu) Kuruluşunuzdaki bir ortam.
-h, --help Komut parametreleriyle ilgili yardımı görüntüler.
--insecure SSL kullanırken güvenli olmayan sunucu bağlantılarına izin ver.
-o, --org Dize (Zorunlu) Bir Apigee kuruluşu. Kuruluş yöneticisi olmanız gerekir.
-r, --runtime Dize (Yalnızca Private Cloud) Private Cloud örneğinizin çalışma zamanı URL'sini belirtir.
-v, --verbose (İsteğe bağlı) Ayrıntılı çıkış üretir.

Örnek

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

Çıkış

İşlem başarılı olduğunda aşağıdakine benzer bir JST jeton çıkışı görürsünüz:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

JWT jetonunu inceleme

Bu komutla JWT jetonunu inceleyebilirsiniz. Ayrıca bkz. Jetonu inceleme.

Kullanım

Edge Herkese Açık Bulut için:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
Edge Private Cloud için:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

Parametreler

Parametreler Tür Açıklama
-c, --config Dize (Gerekli) Apigee Remote Service yapılandırma dosyasının yolu.
. İpucu: Bu işaret, diğer komut parametrelerini atlamanıza olanak tanır çünkü CLI, bunları doğrudan yapılandırma dosyasından alabilir. Bkz. --config seçeneğini kullanma.
-e, --env Dize (Zorunlu) Kuruluşunuzdaki bir ortam.
-h, --help Komut parametreleriyle ilgili yardımı görüntüler.
--insecure SSL kullanırken güvenli olmayan sunucu bağlantılarına izin ver.
-o, --org Dize (Zorunlu) Bir Apigee kuruluşu. Kuruluş yöneticisi olmanız gerekir.
-r, --runtime Dize (Yalnızca Private Cloud) Private Cloud örneğinizin çalışma zamanı URL'sini belirtir.
-v, --verbose (İsteğe bağlı) Ayrıntılı çıkış üretir.

Örnek

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

Çıkış

İşlem başarılı olduğunda şuna benzer bir çıkış görürsünüz:
{
	"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.

JWT jetonu döndürme

İlk kez bir JWT oluşturduktan bir süre sonra, ortak/özel anahtarı değiştirmeniz gerekebilir. çiftinin şifreli anahtar/değer haritasında (KVM) depoladığı bir pakettir. Bu içerik üretme süreci yeni bir anahtar çiftine anahtar rotasyonu denir. Anahtarları döndürdüğünüzde yeni bir özel/ortak anahtar çifti oluşturulur ve "istio"da depolanır Apigee Edge kuruluşunuzda/ortamınızda KVM'ye gidin. Ayrıca eski ortak anahtar, orijinal anahtar kimliği değeriyle birlikte korunur.

Kullanım

Edge Public Cloud kullanıyorsanız:
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
Edge Private Cloud kullanıyorsanız:
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]

Parametreler

Parametreler Tür Açıklama
-c, --config Dize (Gerekli) Apigee Remote Service yapılandırma dosyasının yolu.
. İpucu: Bu işaret, diğer komut parametrelerini atlamanıza olanak tanır çünkü CLI, bunları doğrudan yapılandırma dosyasından alabilir. Bkz. --config seçeneğini kullanma.
-e, --env Dize (Zorunlu) Kuruluşunuzdaki bir ortam.
-h, --help Komut parametreleriyle ilgili yardımı görüntüler.
--insecure SSL kullanırken güvenli olmayan sunucu bağlantılarına izin ver
--truncate int jwks'de saklanacak sertifika sayısı (varsayılan 2)
-o, --org Dize (Zorunlu) Bir Apigee kuruluşu. Kuruluş yöneticisi olmanız gerekir.
-r, --runtime Dize (Yalnızca Private Cloud) Private Cloud örneğinizin çalışma zamanı URL'sini belirtir.
-v, --verbose (İsteğe bağlı) Ayrıntılı çıkış üretir.

Örnek

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

Çıkış

certificate successfully rotated

Kimlik bilgileri için .netrc'ü kullanma

apigee-remote-service-cli, username cihazını otomatik olarak anlar ve .netrc cihazından password (gerektiğinde temel kimlik doğrulama için) dosyasını ana dizininizde bulabilirsiniz (Edge Public Cloud'daysanız ve api.enterprise.apigee.com. makine. Apigee Private Cloud kullanıyorsanız makine değeri management URL'nizle aynı (örneğin: http://192.162.55.100) tıklayın. Örneğin, Edge Public Cloud'da:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Örneğin, Edge Private Cloud'da:
machine http://192.162.55.100
login jdoe@google.com
password abc123

Sürüm komutu

CLI sürümünü yazdırın.

apigee-remote-service-cli version

--config komut seçeneğini kullanma

--config seçeneği konumu belirtir provision komutuyla oluşturulan yapılandırma dosyasının tamamını girin. Bu seçeneğin yararlı bir avantajı, KSA'nın yapılandırma dosyasından aldığı diğer komut parametrelerinin çoğunu atlamanıza olanak tanır. Bu seçenekler şunlardır:
  • kuruluş
  • ortam
  • çalışma zamanı
  • yönetimi
  • güvensiz
  • ad alanı
  • eski
  • opdk

Örneğin, provision komutunu şu şekilde yürütebilirsiniz:

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

Yapılandırma dosyası

Bu bölümde, kullanılabilir tüm seçenekleri içeren örnek bir yapılandırma dosyası gösterilmektedir.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 1m
  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
  jwt_provider_key: https://org-test.apigee.net/remote-service/token