Esegui il deployment di Edge Microgateway come proxy sidecar

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

Introduzione

Questo argomento spiega come eseguire Edge Microgateway in un cluster Kubernetes come proxy Sidecar. Sono disponibili due opzioni per il deployment del file collaterale: manuale e iniezione automatica. Questo argomento descrive entrambe le opzioni.

Per saperne di più, consulta Introduzione a Edge Microgateway su Kubernetes.

Prima di iniziare

Completa la procedura descritta nella sezione Prerequisiti.

Esegui il deployment di un servizio di test

Esegui il deployment di un semplice servizio "hello" e verifica il deployment:

  1. Esegui il deployment dell'esempio:

    kubectl apply -f samples/helloworld/helloworld.yaml --namespace=default
  2. Verifica che il servizio sia in esecuzione. Potrebbe essere necessario attendere qualche istante prima che il pod torni allo stato di esecuzione:

    kubectl get pods --namespace=default

    Output di esempio:

    NAME                          READY     STATUS    RESTARTS   AGE
    helloworld-569d6565f9-lwrrv   1/1       Running   0          17m
    
  3. Elimina il deployment del servizio di test. La reinstallerai in un secondo momento, dopo aver abilitato l'iniezione collaterale:

     kubectl delete -f samples/helloworld/helloworld.yaml --namespace=default

Utilizzo dell'iniezione manuale del file collaterale

Delle due opzioni di inserimento sidecar, l'inserimento manuale del sidecar è l'approccio più semplice e diretto e può essere eseguito con un singolo comando kubectl.

Configura Edge Microgateway

Il comando seguente configura Edge Microgateway per la tua organizzazione Apigee ed esegue il deployment del proxy edgemicro-auth.

  1. Esegui questo comando:

    edgemicro configure -o [org] -e [env] -u [username]

    Dove:

    • org: nome della tua organizzazione Edge (devi essere un amministratore dell'organizzazione).

    • env: un ambiente della tua organizzazione (ad esempio test o produzione).

    • username: l'indirizzo email associato al tuo account Apigee.

    Esempio

    edgemicro configure -o myorg -e test -u jdoe@example.com

    L'output (esempio mostrato di seguito) viene salvato nel file:

    $HOME/.edgemicro/org_name-env_name-config.yaml
    .

    current nodejs version is v6.9.1
    current edgemicro version is 2.5.25
    password:
    file doesn't exist, setting up
    Give me a minute or two... this can take a while...
    App edgemicro-auth deployed.
    checking org for existing KVM
    KVM already exists in your org
    configuring host edgemicroservices.apigee.net for region us-west1
    
    saving configuration information to: /Users/jdoe/.edgemicro/myorg-test-config.yaml
    
    vault info:
     -----BEGIN CERTIFICATE-----
    MIICpDCCAYwCCQCV9eBcO9a5WzANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDDAls
    b2NhbGhvc3QwHhcNMagwODA5MDAzMDEzWhcNMTgwODEwMDAzMDEzWjAUMRIwEAYD
    VQQDDBlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDh
    nAHT7JHX/WvWHRFb8FLm53SPIDld5LyPOUfINdEyhSIEeXoOUKg4EPweJPVSC9Vm
    Hw4ZMtEqWJM/XsQWvLe8ylRJa5wgmzmFCqAsuzs9+rmc9KvJqjpOh2uRTUf7KKfT
    iXL2UEseprcI5g8zNyqKyEf/ecWIwz3AkkPAZebVTsrdDfIDHvkyhhvlAHZAB9kn
    GtqP3N8kOlv4KQto9Gr7GYUGUIDugt7gM1F611+RBS+fYRi32GUAq/UQDkhYL8cp
    oIJiF7UYkk2+9t9CdOCDuIUCvJioHJQd0xvDpkC9f6LvwjwnCwku+4F2Q63+av5I
    mJoZJQPvW5aP53Qkk+kHAgMBAAEwDKYJKoZIhvcNAQELBQADggEBALyUBolXUFN8
    1bf268nR+gS8MOFDTxO1bUz+bKuT/g3K1PuNUJTueT+0L1H2OiZUzazAqwn2sqzN
    lQuvLg6LjxjlNkqTJGiJvGDcYVq45dv7UyxAZxhqxTxhlQ+Yu5R9pbQnzujezHpH
    6gtCoCkSt/QqiJ3YsmsVu5is+HpIJepMt0CyMh5tK9j87hl46QhHklaVfQ3ycMVm
    /wNPR/pjizg1FDUeq4nj/7DBVbMf9net/BDaZLeSW1HJ1vcsCXIcSZfQd4QymGFn
    8ADrND7ydVjwO/s23soPDTy0g4yLIZvky2tpT8d7YahNqSv2n7sXsLxruzcyCoQ4
    w+e3Z3F7IKI=
    -----END CERTIFICATE-----
    
    The following credentials are required to start edge micro
      key: 1a3b2754c7f20614817b86e09895825ecc252d34df6c4be21ae24356f09e6eb4
      secret: 16ad2431de73f07f57a6d44048f08d93b63f783bf1f2ac4221182aa7289c7cef
    
    edgemicro configuration complete!
    

Inserisci Edge Microgateway come sidecar

Per inserire manualmente Edge Microgateway in un pod di servizio come proxy sidecar, esegui questo comando:

kubectl apply -f <(edgemicroctl -org=your_org -env=your_env -key=your_key -sec=your_secret -conf=config_file_path -svc=service_deployment_file)

dove:

  • your_org: l'organizzazione Apigee specificata nel comando edgemicro configure.
  • your_env: l'ambiente specificato nel comando edgemicro configure.
  • your_key: la chiave restituita dal comando edgemicro configure.
  • your_secret: il secret restituito dal comando edgemicro configure.
  • config_file_path: il percorso del file di configurazione Edge Micro restituito dal comando edgemicro configure.
  • service_deployment_file: il percorso del file di deployment del servizio il cui pod riceverà il servizio collaterale associato. Ad esempio: samples/helloworld/helloworld.yaml.

Ad esempio:

kubectl apply -f <(edgemicroctl -org=myorg -env=test-key=0e3ecea28a64099410594406b30e54439af5265f8 -sec=e3919250bee37c69cb2e5b41170b488e1c1d -conf=/Users/jdoe/.edgemicro/myorg-test-config.yaml -svc=samples/helloworld/helloworld.yaml)

Testare la configurazione

  1. Controlla i deployment dei servizi:

    kubectl get services -n default

    Output di esempio:

    NAME         TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
    helloworld   NodePort    10.15.254.163   <none>        8081:32401/TCP   56s
    kubernetes   ClusterIP   10.15.240.1     <none>        443/TCP          41m
    
  2. Ora è tutto pronto per testare il deployment collaterale di Edge Microgateway. Per la procedura dettagliata, consulta Testare il proxy.

Utilizzo dell'iniezione automatica del file collaterale

Nei passaggi seguenti, configurerai l'inserimento automatico di sidecar per il tuo cluster Kubernetes. Questa configurazione consente a Edge Microgateway di essere inserito come proxy sidecar in Kubernetes.

Installa l'iniettore sidecar

  1. Installa il file ConfigMap che abilita l'inserimento sidecar di Edge Microgateway:

    kubectl apply -f install/kubernetes/edgemicro-sidecar-injector-configmap-release.yaml
  2. Esegui lo script seguente per installare il servizio webhook. Il servizio webhook è necessario per l'inserimento automatico del file collaterale:

    ./install/kubernetes/webhook-create-signed-cert.sh \
        --service edgemicro-sidecar-injector \
        --namespace edgemicro-system \
        --secret sidecar-injector-certs
    
  3. Aggiungi il bundle CA al file di installazione del webhook. L'api-server Kubernetes utilizza questo file per richiamare il webhook:

    cat install/kubernetes/edgemicro-sidecar-injector.yaml | \
         ./install/kubernetes/webhook-patch-ca-bundle.sh > \
         install/kubernetes/edgemicro-sidecar-injector-with-ca-bundle.yaml
    
  4. Installa il webhook iniettore sidecar Edge Microgateway:

    kubectl apply -f install/kubernetes/edgemicro-sidecar-injector-with-ca-bundle.yaml
    

    Output di esempio:

    service "edgemicro-sidecar-injector" created
    serviceaccount "edgemicro-sidecar-injector-service-account" created
    deployment "edgemicro-sidecar-injector" created
    mutatingwebhookconfiguration "edgemicro-sidecar-injector" created
    
  5. Verifica che il webhook dell'iniettore sidecar Edge Microgateway sia in esecuzione:

    kubectl -n edgemicro-system get deployment -ledgemicro=sidecar-injector
    

    Output di esempio:

    NAME                         DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
    edgemicro-sidecar-injector   1         1         1            1           12m
    
  6. Verifica che il pod di inserimento sidecar sia in esecuzione nel cluster. Lo spazio dei nomi edgemicro-system è il luogo in cui sono installati i servizi di sistema, tra cui il controller Ingress, il backend HTTP predefinito e l'iniettore sidecar:

    kubectl get pods -n edgemicro-system

    Output di esempio:

    NAME                                            READY     STATUS    RESTARTS   AGE
    default-http-backend-55c6c69b88-gfnfd           1/1       Running   0          1h
    edgemicro-ingress-controller-64444469bf-jhn8b   1/1       Running   3          1h
    edgemicro-sidecar-injector-7d95698fbf-cq84q     1/1       Running   0          3m
    

Configura e inserisci Edge Microgateway

Nel passaggio successivo eseguirai uno script interattivo per creare una configurazione Edge Microgateway associata a uno spazio dei nomi Kubernetes. Quindi, inserirai la configurazione nel cluster Kubernetes.

  1. Esegui lo script interattivo riportato di seguito e fornisci i parametri richiesti. Il comando genera un profilo di configurazione che utilizzerai nel passaggio successivo.

    ./install/kubernetes/webhook-edgemicro-patch.sh

    Per informazioni sui parametri di input, consulta la sezione Riferimento.

    Input di esempio:

    1. Namespace to deploy application [default]:

      Premi Invio.

    2. Authenticate with OAuth Token ("n","Y") [N/y]

      Inserisci n.

    3. Apigee username [required]:

      Inserisci il tuo nome utente (indirizzo email) Apigee. Ad esempio: jdoe@google.com.

    4. Apigee password [required]:

      Inserisci la password Apigee.

    5. Apigee organization [required]:

      Inserisci il nome della tua organizzazione Apigee.

    6. Apigee environment [required]:

      Inserisci un nome di ambiente per la tua organizzazione. Ad esempio, "test".

    7. Virtual Host [default]:

      Premi Invio.

    8. Is this Private Cloud ("n","y") [N/y]:

      Inserisci n se ti trovi nel cloud pubblico.

    9. Edgemicro Key. Press Enter to generate:

      Premi Invio.

    10. Edgemicro Secret. Press Enter to generate:

      Premi Invio.

    11. Edgemicro org-env-config.yaml. Press Enter to generate:

      Premi Invio.

      Output di esempio:

      current nodejs version is v6.9.1
      current edgemicro version is 2.5.25
      config initialized to /Users/jdoe/.edgemicro/default.yaml
      Configure for Cloud
      ******************************************************************************************
      Config file is Generated in /Users/jdoe/Work/GITHUB/microgateway_2.5.25_Darwin_x86_64/config directory.
      
      Please make changes as desired.
      *****************************************************************************************
      
    12. Do you agree to proceed("n","y") [N/y]:

      Inserisci y.

      Output di esempio:

      Configuring Microgateway with
      
      key:daacf75dd660d160b801c9117fb1ec0935896615479e39dbbae88be81a2d84
      secret:a60fd57c1db9f3a06648173fb541cb9c59188d3b6037a76f490ebf7a6584b0
      config:~/.edgemicro/jdoe-test-config.yaml
      
      ********************************************************************************************************
      kubectl apply -f install/kubernetes/edgemicro-config-namespace-bundle.yaml
      ********************************************************************************************************
      
  2. Esegui il comando indicato nell'ultima riga dell'output. Questo comando kubectl inserisce in Kubernetes il profilo di configurazione Edge Microgateway generato:

    kubectl apply -f install/kubernetes/edgemicro-config-namespace-bundle.yaml
  3. Visualizza lo stato dell'inserimento di webhook. Tieni presente che al momento questa funzione non è attiva:

    kubectl get namespace -L edgemicro-injection

    Output di esempio:

    NAME               STATUS    AGE       EDGEMICRO-INJECTION
    default            Active    1d
    edgemicro-system   Active    1d
    kube-public        Active    1d
    kube-system        Active    1d
    
  4. Esegui questo comando per abilitare l'inserimento di webhook per il webhook:

    kubectl label namespace default edgemicro-injection=enabled
  5. Visualizza di nuovo lo stato dell'inserimento di webhook. Tieni presente che ora è attivata:

    kubectl get namespace -L edgemicro-injection

    Output di esempio:

    NAME               STATUS    AGE       EDGEMICRO-INJECTION
    default            Active    1d        enabled
    edgemicro-system   Active    1d
    kube-public        Active    1d
    kube-system        Active    1d
    

Esegui il deployment del servizio di test

Ora esegui nuovamente il deployment del servizio di test. Edge Microgateway verrà inserito automaticamente nel pod del servizio.

kubectl apply -f samples/helloworld/helloworld.yaml --namespace=default

Conferma che Edge Microgateway sia stato inserito nel pod insieme al servizio di test:

kubectl get pods --namespace=default --watch

Output di esempio:

NAME                          READY     STATUS            RESTARTS   AGE
helloworld-6987878fc4-pkw8h   0/2       PodInitializing   0          12s
helloworld-6987878fc4-pkw8h   2/2       Running           0         26s

Quando lo stato diventa Running, premi ctrl-c per uscire dal comando.

Ora è tutto pronto per testare il deployment automatico del sidecar di Edge Microgateway. Per la procedura dettagliata, consulta Testare il proxy.

Testa il proxy

Con il deployment sidecar, viene creato automaticamente un proxy API per il tuo servizio. Non è necessario creare un proxy "Edge Microgateway-aware".

Recuperare l'indirizzo IP Ingress

Con l'IP esterno per Ingress, puoi chiamare il servizio dall'esterno del cluster.

  1. Ottieni l'indirizzo IP esterno del controller Ingress:

    kubectl get ing -o wide

    Output di esempio:

    NAME      HOSTS     ADDRESS        PORTS     AGE
    gateway   *         35.238.13.54   80        1m
    
  2. Copia il valore EXTERNAL-IP per la risorsa Ingress ed esportalo in una variabile. Puoi impostare la variabile manualmente:

    export GATEWAY_IP=external_ip

    Ad esempio:

    export GATEWAY_IP=35.238.249.62

    In alternativa, utilizza questo comando per impostarlo:

    export GATEWAY_IP=$(kubectl describe ing gateway --namespace default | grep "Address" | cut -d ':' -f2 | tr -d "[:space:]")
  3. Verifica che la variabile sia stata esportata. Ad esempio:

    echo $GATEWAY_IP

    Output di esempio:

    35.238.249.62
    
  4. Chiama il servizio:

    curl $GATEWAY_IP

    Output:

    {"error":"missing_authorization","error_description":"Missing Authorization header"}
    

    A questo punto, risolverai l'errore di autorizzazione mancante configurando un prodotto API e un'app per sviluppatori su Edge, in modo da ottenere una chiave API valida. Quando aggiungi la chiave a un'intestazione di autorizzazione per la chiamata API, la chiamata avrà esito positivo e non visualizzerai questo errore.

Crea componenti su Apigee Edge

Quindi, crea un prodotto API e un'app per sviluppatori su Apigee Edge.

Crea un prodotto API

  1. Accedi ad Apigee Edge.
  2. Seleziona Pubblica > Prodotti API nel menu di navigazione laterale.
  3. Fai clic su + Prodotto API. Viene visualizzata la pagina del prodotto.
  4. Compila la pagina Prodotto come segue. Per i campi non menzionati di seguito, puoi utilizzare i valori predefiniti. Non salvare fino a quando ti viene chiesto di farlo.

    Nome hello-world-product
    Display Name Edge Micro hello product
    Ambiente test

  5. Nella sezione Percorso, fai clic su + Risorsa personalizzata.

  6. Aggiungi il percorso /.

  7. Fai di nuovo clic su + Risorsa personalizzata e aggiungi il percorso /**.

  8. Nella sezione Proxy API, fai clic su + Proxy API e aggiungi edgemicro-auth.

  9. Salva il prodotto API.

Creazione di un'app sviluppatore

  1. Seleziona App nel menu di navigazione laterale.
  2. Fai clic su + App. Viene visualizzata la pagina Dettagli app sviluppatore.
  3. Compila la pagina App sviluppatore come segue. Non salvare fino a quando ti viene chiesto di farlo.

    Nome hello-world-app
    Display Name Edge Micro hello app
    Developer Seleziona uno sviluppatore dal menu a discesa.
  4. Nella sezione Credenziali, fai clic su + Prodotto e seleziona la hello-world-product appena creata.

  5. Fai clic su Salva.

  6. Sei tornato alla pagina con l'elenco di tutte le app sviluppatore.

  7. Seleziona l'app appena creata, hello-world-app.

  8. Fai clic su Mostra accanto alla Chiave utente.

  9. Copia il valore della chiave consumer. Questo valore è la chiave API che utilizzerai per effettuare chiamate API sicure al servizio helloworld.

  10. Attendi qualche minuto. Sono necessari alcuni minuti perché le modifiche apportate su Apigee Edge vengano sincronizzate con l'istanza di Edge Microgateway di cui è stato eseguito il deployment nel cluster.

Chiama l'API

Dopo aver eseguito il pull delle modifiche alla configurazione nel microgateway, puoi eseguire i seguenti test.

  1. Chiama l'API senza una chiave API. Visualizzerai un messaggio di errore, come mostrato di seguito:

    curl $GATEWAY_IP

    Output previsto:

    {"error":"missing_authorization","error_description":"Missing Authorization
    header"}
    

    Per effettuare correttamente chiamate API, è necessaria la chiave API.

  2. Recupera la chiave utente dall'app sviluppatore che hai creato. Questo valore è la chiave API che devi chiamare il proxy di prova:

    curl -H 'x-api-key:your-edge-api-key'  $GATEWAY_IP

    Ad esempio:

    curl -H "x-api-key:DeX2eEesYAdRJ5Gdbo77nT9uUfJZql19" $GATEWAY_IP

    Output:

    Hello world
    

    La risposta "Hello world" viene restituita dal servizio helloworld di cui è stato eseguito il deployment nel pod. La chiamata a quel servizio è passata prima attraverso Edge Microgateway, dove è stata eseguita l'autenticazione. Se viene visualizzata la risposta "Hello world", significa che hai configurato Edge Microgateway per funzionare come proxy sidecar nel pod del servizio helloworld.

Passaggi successivi

Consulta la sezione Attività per informazioni su come aggiungere plug-in personalizzati, scalare il deployment, apportare modifiche alla configurazione e altre attività che potresti voler eseguire.