Como implantar proxies na linha de comando

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Neste tópico, explicamos como implantar um proxy usando a linha de comando. O Apigee Edge oferece duas opções para implantação a partir da 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 de linha de comando ao trabalhar diretamente com arquivos de origem de proxy no seu sistema. Há muitas razões para você trabalhar off-line. Você pode usar um editor XML favorito ou pode estar desenvolvendo políticas que exigem programação Java e estiver 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 de serviços de API escolhido.

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

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation.
info

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

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

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

A ferramenta de implantação precisa ser executada no diretório base na distribuição da distribuição do Platform Samples, em que o diretório base é o pai dos diretórios 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 os 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, cancela a implantação da revisão existente e implanta uma revisão incrementada do proxy de API.

Se houver êxito, você verá a saída no formulário:

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 upload do proxy de API para https://api.enterprise.apigee.com, que corresponde ao Edge na nuvem. Também é possível usar essa ferramenta para fazer upload do proxy de API para uma versão local do Edge especificando a sinalização -h:

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 de borda. Se tiver criado um registro DNS para o servidor de gerenciamento, você poderá especificar um URL no seguinte formato:

https://ms_URL:8080

A lista completa de sinalizações do comando é:

  • -n: o nome do proxy de API.
  • -u: o nome de usuário e a senha da conta em uma organização na 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 da 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 de URI usado como correspondência de padrão para rotear a mensagem recebida para essa implantação de proxy de API. Na maioria dos casos, você pode definir esse valor como "/", a menos que tenha requisitos avançados de implantação e roteamento. O caminho principal usado para o roteamento do proxy de API é definido no arquivo de configuração ProxyEndpoint do proxy de API.
  • -h: o URL de borda. Por padrão, o URL é https://api.enterprise.apigee.com, que corresponde ao Edge na nuvem. Para uma implantação local, use o URL do servidor de gerenciamento de borda 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 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.

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 você precisa modificar o arquivo /setup/setenv.sh na distribuição de amostras de plataforma. Para instruções, consulte o README ou as APIs Apigee Edge.

Se for bem-sucedida, a ferramenta de implantação empacota os arquivos em /apiproxy, e importa o pacote para sua organização no Apigee Edge e, em seguida, implanta o proxy de API no ambiente de "teste".

Seu proxy de API está pronto para ser invocado.