Instalação do API BaaS

Edge para nuvem privada v4.18.01

Visão geral da instalação

Depois de instalar o utilitário apigee-setup do Edge em um nó, use-o para instalar um ou mais componentes do BaaS no nó.

O utilitário apigee-setup tem este formato:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Transmita um arquivo de configuração para o utilitário apigee-setup com as informações sobre a instalação. Se o arquivo de configuração não tiver as informações necessárias, o utilitário apigee-setup solicitará que você as insira na linha de comando.

O único requisito é que o arquivo de configuração esteja acessível ou legível pelo usuário "apigee".

Por exemplo, use o seguinte comando para instalar a pilha BaaS da API:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p b -f myConfig

Como especificar os componentes a serem instalados

O utilitário setup.sh da Apigee oferece suporte a várias opções de instalação de componentes da API BaaS. As instruções abaixo usam as opções independentes (c, e, b e p), mas você pode usar opções diferentes com base na configuração do seu nó:

Opção

Descrição

e

Instale somente o ElasticSearch.

b

Instale somente a API BaaS Stack, que também instala o Tomcat.

p

Instale somente o portal BaaS da API, que também instala o roteador Nginx para ser usado como um servidor da Web.

c

Instale somente o Cassandra.

eb

Instalar o ElasticSearch, a API BaaS Stack e o Tomcat no nó.

Ebp

Instale o ElasticSearch, o portal de API BaaS, o API BaaS Stack e o Tomcat, mas não o Cassandra. O portal é tão leve que não é preciso usar outros recursos para isso.

Asa

Instale todos os componentes da API BaaS em um único nó (Cassandra, Elasticsearch, API BaaS Stack, Portal da API BaaS, Tomcat). Use essa opção apenas para desenvolvimento e testes, não para produção.

Como criar um arquivo de configuração

O arquivo de configuração contém todas as informações necessárias para instalar o BaaS da API. Muitas vezes, é possível usar o mesmo arquivo de configuração para instalar todos os componentes em uma instalação do BaaS.

Cada topologia de instalação descrita abaixo mostra um exemplo de arquivo de configuração para essa topologia. Para uma referência completa sobre o arquivo de configuração, consulte Referência do arquivo de configuração BaaS.

Instalar o BaaS da API em um único nó

O arquivo de configuração para instalar o BaaS da API em um único nó é mostrado abaixo. Edite esse arquivo conforme necessário para sua configuração. Para uma referência completa sobre o arquivo de configuração, consulte a Referência do arquivo de configuração BaaS.

IP1=192.168.56.101   # IP address of single node

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Because you are installing Cassandra,
# specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify Cassandra data center name.
BAAS_CASS_LOCALDC=dc-1

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For dc-1 with one Cassandra node, it is dc-1:1.
BAAS_CASS_REPLICATION=dc-1:1

# Defines the initial contact points for members of the BaaS cluster. 
# For a single node install, specify the IP address of the node. 
BAAS_CLUSTER_SEEDS="dc-1:$IP1"

# Single ElasticSearch IP.
ES_HOSTS="$IP1"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# IP/DNS and port 8080 of a single Stack node.
BAAS_USERGRID_URL="http://$IP1:8080"

# URL and port of the BaaS Portal node.  
BAAS_PORTAL_URL="http://$IP1:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPMAILFROM="My Company <myco@company.com>"

Para instalar o BaaS da API no próprio nó:

  1. Instale o utilitário apigee-setup do Edge no nó usando o procedimento na Internet ou fora dela. Consulte Instalar o utilitário Edge apigee-setup para saber mais.
  2. No prompt de comando, execute o script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p asa -f configFile

    A opção "-p asa" especifica a instalação de todos os componentes da API BaaS em um único nó (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat).
    O arquivo de configuração precisa estar acessível ou legível para o usuário "apigee".
  3. Como você instalou o ElasticSearch em um nó independente, ajuste a opção de memória padrão para aumentar a memória alocada para o ElasticSearch de 4 GB para 6 GB:
    1. Abra /opt/apigee/customer/application/elasticsearch.properties em um editor. Se o arquivo não existir, crie-o.
    2. Defina a propriedade setenv_elasticsearch_max_mem_size como 6g (o padrão é 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Salve o arquivo.
    4. Execute este comando:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart
  4. ?Integrar uma organização conforme descrito abaixo em Como integrar uma nova organização.

A configuração conclui a definição no nó.

Instalar o BaaS da API em 7 ou 10 nós

O procedimento para instalar uma versão de 7 ou 10 nós da API BaaS é muito parecido. A única diferença é que para um:

  • 10 nós, você instala os três componentes do ElasticSearch e três componentes de pilha BaaS de API em nós separados, para um total de seis nós. Essa é a configuração recomendada para ter o melhor desempenho porque o ElasticSearch requer uma alta quantidade de E/S de disco e memória.
  • com sete nós, você instala os três componentes do ElasticSearch e os três componentes da pilha de API BaaS nos mesmos nós, para um total de três nós.

Para as versões 7 e 10 de nós da API BaaS, é preciso se conectar a um cluster do Cassandra. Se você já instalou o Edge, é possível se conectar ao cluster do Cassandra, o que significa que não precisa instalar o Cassandra como parte da instalação do BaaS da API.

Veja abaixo um exemplo de arquivo de configuração silenciosa para uma instalação do BaaS da API de 10 nós. Se você estiver instalando os componentes ElasticSearch e API BaaS Stack nos mesmos três nós, edite o arquivo para que:

  • IP1 e IP4 estejam definidos como o mesmo endereço IP
  • IP2 e IP5 estejam definidos como o mesmo endereço IP
  • IP3 e IP6 estejam definidos como o mesmo endereço IP

Edite esse arquivo conforme necessário para sua configuração. Para uma referência completa sobre o arquivo de configuração, consulte Referência do arquivo de configuração BaaS.

# Specify IP address or DNS name of node.
IP1=192.168.1.1   # ElasticSearch
IP2=192.168.1.2   # ElasticSearch
IP3=192.168.1.3   # ElasticSearch
IP4=192.168.1.4   # API BaaS Stack
IP5=192.168.1.5   # API BaaS Stack
IP6=192.168.1.6   # API BaaS Stack
IP7=192.168.1.7   # API BaaS Portal
IP8=192.168.1.8   # Cassandra (shared with Edge or standalone)
IP9=192.168.1.9   # Cassandra (shared with Edge or standalone)
IP10=192.168.1.10  # Cassandra (shared with Edge or standalone)

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Only if you are installing Cassandra.
# Specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
# CASS_HOSTS="$IP8:1,1 $IP9:1,1 $IP10:1,1"

# If connecting to existing Cassandra nodes, 
# specify Cassandra IPs.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP8 $IP9 $IP10"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify BaaS Cassandra connection information.
# Specify the data center name.
BAAS_CASS_LOCALDC=dc-1    # Default is dc-1.

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For example, for dc-1 with three Cassandra nodes, it is dc-1:3.
BAAS_CASS_REPLICATION=dc-1:3

# Defines the initial contact points for members of the BaaS cluster. 
# Specify the IP address of no more than two Stack nodes. 
BAAS_CLUSTER_SEEDS="dc-1:$IP4,dc-1:$IP5"

# ElasticSearch IPs or DNS names, separated by spaces.
ES_HOSTS="$IP1 $IP2 $IP3"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# URL and port of the load balancer for the API BaaS Stack nodes, 
# or IP/DNS and port 8080 of a single Stack node with no load balancer.
BAAS_USERGRID_URL=http://myloadbalancer:8443

# API BaaS Portal information.
# URL and port number of load balancer, if there is one in front of the Portal,
# or the URL and port of the Portal node.  
BAAS_PORTAL_URL="http://$IP7:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000 

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPMAILFROM="My Company <myco@company.com>"

Opcional: instale o Cassandra: máquinas 8, 9 e 10

É possível conectar o BaaS da API ao mesmo cluster do Cassandra usado pelo Edge. Se você não instalou o Edge, poderá instalar o Cassandra para uso pelo BaaS da API.

O cluster do Cassandra pode usar a autenticação ou a autenticação do Cassandra pode ser desativada. Consulte Ativar a autenticação do Cassandra para saber mais.

  1. Instale o utilitário apigee-setup do Edge no nó usando o procedimento Internet ou não. Consulte Instalar o utilitário Edge apigee-setup para saber mais.
  2. No prompt de comando, execute este script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p c -f configFile

    A opção “-p c” especifica a instalação do Cassandra.
    O arquivo de configuração precisa estar acessível ou legível para o usuário "apigee".

A configuração conclui a definição do armazenamento de dados no nó.

Observe que o JMX está ativado por padrão para o Cassandra. O acesso remoto do JMX ao Cassandra não requer uma senha. É possível configurar o Cassandra para usar a autenticação para o JMX. Para mais informações, consulte Como monitorar.

Configurar o cron job do Cassandra

Se precisar instalar o Cassandra, configure um cron job que use o nodetool para limpar os bloqueios a serem executados a cada hora em cada nó do Cassandra.

Se você tiver vários nós do Cassandra, desloque o cron job em cada servidor em cinco minutos para que todos eles não sejam apagados ao mesmo tempo.

O cron job precisa executar o seguinte comando:

/opt/apigee/apigee-cassandra/bin/nodetool -h IP_address flush Apigee_Baas_Locks

em que IP_address é o endereço IP do nó do Cassandra.

Instalar o ElasticSearch: máquinas 1, 2 e 3

Para instalar o ElasticSearch no próprio nó:

  1. Instale o utilitário de configuração da Apigee Apigee no nó usando o procedimento on-line ou não. Consulte Instalar o utilitário Edge apigee-setup para saber mais.
  2. No prompt de comando, execute o script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p e -f configFile

    A opção “-p e” especifica a instalação do ElasticSearch.
    O arquivo de configuração precisa estar acessível ou legível para o usuário "apigee".
  3. (Opcional) Se você instalar o ElasticSearch em um nó independente, o que significa que ele não está instalado com a API BaaS Stack, ajuste a opção de memória padrão para aumentar a memória alocada para o ElasticSearch de 4 GB para 6 GB:
    1. Abra /opt/apigee/customer/application/elasticsearch.properties em um editor. Se o arquivo não existir, crie-o.
    2. Defina a propriedade setenv_elasticsearch_max_mem_size como 6g (o padrão é 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Salve o arquivo.
    4. Execute este comando:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart

A configuração conclui a definição no nó.

Instale a pilha da API BaaS: máquinas 4, 5 e 6

Para instalar a pilha BaaS da API no próprio nó:

  1. Instale o utilitário de configuração da Apigee Apigee no nó usando o procedimento on-line ou não. Consulte Instalar o utilitário Edge apigee-setup para saber mais.
  2. No prompt de comando, execute o script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p b -f configFile

    A opção “-p b” especifica a instalação da pilha de API BaaS.
    O arquivo de configuração precisa estar acessível ou legível para o usuário "apigee".

Depois que o instalador busca as credenciais de administrador corretas, ele instala o Tomcat, cria keyspaces do BaaS de API e configura a pilha de BaaS de API no servidor. O SMTP também está configurado para permitir que a interface envie e-mails de confirmação de senha.

Instalar o portal do BaaS da API: máquina 7

Para instalar o portal da API BaaS:

  1. Instale o utilitário de configuração da Apigee Apigee no nó usando o procedimento on-line ou não. Consulte Instalar o utilitário Edge apigee-setup para saber mais.
  2. No prompt de comando, execute o script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p p -f configFile

    A opção “-p p” especifica a instalação do portal de API BaaS.
    O arquivo de configuração precisa estar acessível ou legível para o usuário "apigee".

    O instalador inicia o servidor da Web Nginx e conclui a configuração do portal da API BaaS.
  3. A próxima etapa depende da sua instalação.
    1. Se você tiver um balanceador de carga na frente dos nós do Portalor Stack, a próxima seção vai descrever como configurar o BaaS da API para os balanceadores de carga.
    2. Se você não tiver um balanceador de carga na frente dos nós do Portalor Stack, integre uma organização conforme descrito abaixo em Como integrar uma nova organização.

Anote o URL do portal da API BaaS. Esse é o URL que você insere em um navegador para acessar a interface do usuário do portal do BaaS da API.

Configurar os nós da API BaaS para um balanceador de carga de pilha ou portal

Se você incluir um balanceador de carga na frente dos nós da pilha ou do portal, será necessário configurar os nós com o URL correto do balanceador de carga. Por exemplo, os nós da pilha exigem essas informações quando:

  • Como incluir um URL nas respostas nas solicitações da API BaaS.
  • adicionar links em modelos de e-mail ao redefinir uma senha ou enviar outras notificações;
  • Redirecionamento de usuários a páginas específicas do portal.

Se você usar um balanceador de carga na frente dos nós da pilha, defina a seguinte propriedade em /opt/apigee/customer/application/usergrid.properties:

usergrid-deployment_usergrid.api.url.base=http://localhost:8080

Substitua http://localhost:8080 pelo URL do balanceador de carga. Se o balanceador de carga estiver configurado para usar TLS, utilize o protocolo HTTPS. Você só precisará incluir a porta se estiver usando uma porta não padrão, ou seja, algo diferente da porta 80 para HTTP e da porta 443 para HTTPS.

Também será necessário definir a seguinte propriedade em /opt/apigee/customer/application/portal.properties se você usar um balanceador de carga na frente dos nós da pilha:

baas.portal.config.overrideUrl=http://localhost:8080

Substitua http://localhost:8080 pelo URL do balanceador de carga da pilha.

Se você usar um balanceador de carga na frente do nó do portal, defina as seguintes propriedades em usergrid.properties:

usergrid-deployment_portal.url=http://localhost:9000

Substitua http://localhost:9000 pelo URL do balanceador de carga. Se o balanceador de carga estiver configurado para usar TLS, utilize o protocolo HTTPS. Você só precisará incluir a porta se estiver usando uma porta não padrão, ou seja, algo diferente da porta 80 para HTTP e da porta 443 para HTTPS.

Depois de editar usergrid.properties e portal.properties:

  1. Configure o nó "Stack":
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid configurar
  2. Reinicie a pilha BaaS:
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid restart

    Observação:ao reiniciar os nós da pilha BaaS, reinicie-os na mesma ordem em que estão listados em BAAS_CLUSTER_SEEDS. BAAS_CLUSTER_SEEDS lista no máximo dois dos nós da pilha. Depois de reiniciar esses dois nós em ordem, você poderá reiniciar os nós restantes em qualquer ordem.

  3. Se você modificou portal.properties, configure o nó do portal:?
    > /opt/apigee/apigee-service/bin/apigee-service baas-portal configuração
  4. Reinicie o portal do BaaS:
    > /opt/apigee/apigee-service/bin/apigee-service restart baas-portal

Integrar uma nova organização

Integração é o processo de criação de uma organização e um administrador dela. Depois de criar o administrador da organização e da organização, faça login na interface do portal do BaaS da API e faça solicitações à API REST da API BaaS.

Quando você cria uma organização, o endereço de e-mail do administrador dela:

  • Precisa ser diferente do endereço de e-mail do administrador do sistema.
  • Precisa ser único entre todas as outras organizações. Ou seja, não é possível criar duas organizações com o mesmo endereço de e-mail do administrador. No entanto, depois de criar a organização, é possível adicionar outros administradores que podem ser duplicados em várias organizações.

Para realizar a integração, use o script Python create_org_and_user.py. Invocar esse script sem argumentos de linha de comando faz com que ele solicite todas as informações:

> python create_org_and_user.py

Também é possível transmitir qualquer uma ou todas as opções como argumento de linha de comando. Você será solicitado a fornecer todas as informações omitidas da linha de comando:

> python create_org_and_user.py -o '<org name>'
> python create_org_and_user.py -o '<org name>' -a '<new admin email>' -p '<new admin password>'

Para criar uma organização, siga estas etapas:

  1. Mude o diretório para /opt/apigee/baas-usergrid/bin.
  2. Invoque o script Python create_org_and_user.py.
    É necessário informar o nome de usuário e a senha de administrador do sistema BaaS para que apenas um administrador do sistema possa executá-la.
  3. Faça login no portal do BaaS da API em um navegador da Web usando o URL que você anotou no final da instalação desse URL. Para acessar o portal, insira o URL do portal do BaaS da API no formato:
    http://{portalExternalIP}:9000/

    Observação: o IP é o endereço IP externo/nome do host da máquina do portal. Verifique se a porta está aberta.
  4. Quando a tela de login do portal for exibida, você poderá:
    • Faça login usando o nome de usuário e a senha do administrador da organização.
    • Faça login usando o nome de usuário e a senha do administrador do sistema.

Como acessar a API REST da API BaaS

Para acessar a API REST da API BaaS, use um URL no formato:

https://{loadBalancerIP}:8080/{your-org}/{your-app}

Em um ambiente de desenvolvimento, é possível instalar todos os componentes da API BaaS em um único nó, o que significa que você tem uma única pilha de BaaS de API. Ou você pode ter um ambiente pequeno com um único nó de pilha BaaS de API e nenhum balanceador de carga. Nesses tipos de ambientes, é possível fazer chamadas de API diretamente para o nó da pilha BaaS da API:

curl -v "http://portalExternalIP:8080/status"

Para mais informações sobre como começar a usar o portal BaaS da API, consulte a documentação da Apigee em: http://apigee.com/docs/content/build-apps-home (em inglês).