Como implantar proxies na linha de comando

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Este tópico explica como implantar um proxy na linha de comando. A Apigee Edge oferece duas opções de implantação na linha de comando. A primeira é usar uma ferramenta de implantação do Apigee Edge escrita em Python. A outra é configurar e executar um script de shell.

Use as técnicas de implantação da linha de comando quando estiver trabalhando diretamente com arquivos de origem de proxy no seu sistema. Há muitos motivos para trabalhar off-line. Talvez você queira usar um editor XML favorito ou esteja desenvolvendo políticas que exigem programação Java e esteja trabalhando principalmente em um ambiente de desenvolvimento integrado. As técnicas descritas nesta seção permitem fazer o upload e implantar os arquivos de origem no ambiente dos serviços de API escolhido.

Se você estiver trabalhando principalmente na interface de gerenciamento, consulte Como implantar proxies na interface.

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Como executar a ferramenta de implantação do Python do Apigee Edge

A ferramenta de implantação do Python do Apigee Edge funciona com a API de gerenciamento do Edge para importar e implantar proxies de API. A ferramenta está disponível como parte da distribuição de amostras da plataforma de API no GitHub. Consulte Como usar os proxies de API de amostra.

Use a ferramenta do Python do Apigee Edge para importar (fazer upload) e implantar sua API em um processo simples.

A ferramenta de implantação precisa ser executada no diretório de base na distribuição de amostras da plataforma de API, em que o diretório de base é o diretório pai do diretório setup e tools.

No comando a seguir, substitua o nome do proxy, o nome de usuário e a senha do Edge, a organização e o ambiente do Edge e o caminho para o diretório que contém o diretório "apiproxy" do proxy de API:

python tools/deploy.py -n proxyname -u name:passW -o org -e env -d proxypath -p /

Exemplo:

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p /

Esse comando compacta seus arquivos, os envia para sua organização no Apigee Edge e os implanta no ambiente especificado.

A ferramenta de implantação descobre automaticamente a revisão atual do proxy de API , desimplanta a revisão atual e implanta uma revisão incrementada do proxy de API.

Em caso de êxito, você verá a saída no formato:

Writing ./<proxybasedir>/apiproxy/weatherapi.xml to apiproxy/weatherapi.xml
Writing ./<proxybasedir>/apiproxy/proxies/default.xml to apiproxy/proxies/default.xml
Writing ./<proxybasedir>/apiproxy/targets/default.xml to apiproxy/targets/default.xml
Imported new proxy version 1
Environment: test
  Revision: 1 BasePath = /
  State: deployed

Por padrão, a ferramenta faz o upload do proxy de API para https://api.enterprise.apigee.com, correspondente ao Edge na nuvem. Também é possível usar essa ferramenta para fazer o upload do proxy de API para uma versão local do Edge especificando a -h flag:

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p / -h https://192.168.11.111:8080

Neste exemplo, você especifica o endereço IP do servidor de gerenciamento do Edge. Se você criou um registro DNS para o servidor de gerenciamento, especifique um URL no seguinte formato:

https://ms_URL:8080

A lista completa de flags para o comando é:

  • -n: o nome do proxy de API.
  • -u: o nome de usuário e a senha da sua conta em uma organização no Apigee Edge.
  • -o: o nome da organização em que você tem uma conta.
  • -e: o ambiente em que o proxy de API precisa ser implantado (test ou prod).
  • -d: o caminho para o diretório que contém os arquivos de proxy de API. Os arquivos de proxy de API precisam ser armazenados em um diretório chamado "apiproxy". Esse valor é o caminho do diretório que contém o diretório "apiproxy" e não o caminho para o próprio diretório "apiproxy".
  • -p: o caminho do URI usado como uma correspondência de padrão para rotear a mensagem recebida para essa implantação de proxy de API. Na maioria dos casos, é possível definir esse valor como '/', a menos que você tenha requisitos avançados de implantação e roteamento. O caminho principal usado para o roteamento de proxy de API é definido em o arquivo de configuração do ProxyEndpoint do proxy de API.
  • -h: o URL do Edge. Por padrão, o URL é https://api.enterprise.apigee.com, correspondente ao Edge na nuvem. Para uma implantação local, use o URL do servidor de gerenciamento do Edge e a porta 8080, como em: 
    https://ms_URL:8080

    Ou use o endereço IP do servidor de gerenciamento, como em https://192.168.11.111:8080.

Como configurar e executar um script de shell de implantação

A abordagem mais fácil é executar o script de implantação fornecido com o proxy de API de amostra. Os scripts de shell envolvem a ferramenta de implantação do Python do Apigee Edge.

No diretório /simplyProxy, execute:

$ sh deploy.sh

Você verá:

Enter your password for user {myname} in the Apigee Enterprise organization {org_name}, followed by [ENTER]:

Digite sua senha e pressione ENTER.

Em seguida, você verá:

Deploying to test on https://api.enterprise.apigee.com using {myname} on enterprise.apigee.com and {org_name} on enterprise.apigee.com

Se você vir o seguinte:

Enter your password for user Your USERNAME on enterprise.apigee.com in the Apigee Enterprise organization Your ORG on enterprise.apigee.com, followed by [ENTER]:

Isso significa que é necessário modificar o arquivo /setup/setenv.sh na distribuição de amostras da plataforma. Para instruções, consulte o arquivo README ou as APIs do Apigee Edge.

Em caso de êxito, a ferramenta de implantação compacta os arquivos em /apiproxy, importa o pacote para sua organização no Apigee Edge e implanta o proxy de API no ambiente de teste.

Seu proxy de API está pronto para ser invocado.