Instalação do API BaaS

Edge for Private Cloud v. 4.17.05

Visão geral da instalação

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

O utilitário apigee-setup o formulário:

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

Transmita um arquivo de configuração para o utilitário apigee-setup que contenha as seguintes informações: sobre a instalação. Se o arquivo de configuração estiver sem configurações o campo apigee-setup solicita que você o digite na linha de comando.

A única exigência é que o arquivo de configuração possa ser acessado ou lido por "apigee" usuário.

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 o opções independentes (c, e, b e p), mas é possível usar opções diferentes com base no nó configuração:

Opção

Descrição

e

Instalar apenas o ElasticSearch.

b

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

p

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

c

Instale apenas o Cassandra.

eb

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

ebp

Instale o ElasticSearch, o Portal de APIs BaaS, a pilha de APIs BaaS e o Tomcat, mas não o Cassandra. O portal é tão leve que não são necessários outros recursos para isso.

Asa

Instalar todos os componentes de API BaaS em um único nó (Cassandra, Elasticsearch, API BaaS) Stack, API BaaS Portal, Tomcat). Use essa opção apenas para desenvolvimento e teste, 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. Você pode geralmente usam 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 do BaaS.

Instalar o BaaS de API em um único nó

Veja abaixo o arquivo de configuração para instalar o BaaS da API em um único nó. Editar este arquivo como necessários para sua configuração. Para uma referência completa sobre o arquivo de configuração, consulte Referência do arquivo de configuração do 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

Para instalar o BaaS da API em um nó próprio:

  1. Instale o utilitário apigee-setup do Edge no nó usando a procedimento on-line ou não. Consulte Instalar o utilitário de configuração da Apigee Apigee (em inglês) para 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 BaaS da API em um único nó (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat).
    O arquivo de configuração precisa ser acessível ou legível para a "apigee" usuário.
  3. Como você instalou o ElasticSearch em um nó autônomo, ajuste a 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. Crie esse arquivo se ele não existir.
    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 reinicialização
  4. Integre uma organização conforme descrito abaixo em Como integrar uma nova organização.

A configuração foi concluída 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 semelhante. O único a diferença é que, para:

  • 10 nós, você instala os três componentes do ElasticSearch e os três componentes Componentes de pilha de BaaS em nós separados, para um total de seis nós. Esta é a configuração recomendada para o melhor desempenho, porque o ElasticSearch exige uma quantidade de E/S e memória de disco.
  • 7 nós, você instala os três componentes do ElasticSearch e os três BaaS de API Empilhe componentes nos mesmos nós, em um total de três nós.

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

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

  • IP1 e IP4 estão definidos para o mesmo endereço IP
  • IP2 e IP5 estão definidos para o mesmo endereço IP
  • IP3 e IP6 estão definidos para o mesmo endereço IP

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

# 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

Opcional - Instalar Cassandra: máquinas 8, 9 e 10

É possível conectar o API BaaS ao mesmo cluster do Cassandra usado pelo Edge. Se você não instalado o Edge, você tem a opção de instalar o Cassandra para uso pela API BaaS.

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

  1. Instale o utilitário apigee-setup do Edge no nó usando a procedimento na Internet ou fora dela. Consulte Instalar o utilitário de configuração da Apigee Apigee (em inglês) para mais.
  2. No prompt de comando, execute o 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 ser acessível ou legível para a "apigee" usuário.

A configuração conclui com êxito a configuração do repositório 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 exigem uma senha. Você pode 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 for preciso instalar o Cassandra, configure um cron job que use o nodetool para liberar os bloqueios a cada hora em cada nó do Cassandra.

Se você tiver vários nós do Cassandra, reduza o cron job em cada servidor em cinco minutos para que para que nenhum dos nós seja liberado 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.

Instale o ElasticSearch: Máquinas 1, 2 e 3

Para instalar o ElasticSearch em um nó próprio:

  1. Instalar o utilitário de configuração da Apigee Apigee no nó usando a Internet ou não procedimento Consulte Instalar a configuração da Apigee do Edge 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 ser acessível ou legível para a "apigee" usuário.
  3. (Opcional) Se você instalar o ElasticSearch em um nó autônomo, ou seja, ele não está instalado com a pilha de BaaS de API e, em seguida, ajustar a opção de memória padrão para aumentar a memória alocada para ElasticSearch de 4 GB a 6 GB:
    1. Abra /opt/apigee/customer/application/elasticsearch.properties. em um editor. Crie esse arquivo se ele não existir.
    2. Defina a variável 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 reinicialização

A configuração foi concluída no nó.

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

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

  1. Instalar o utilitário de configuração da Apigee Apigee no nó usando a Internet ou não procedimento Consulte Instalar a configuração da Apigee do Edge 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 BaaS da API.
    O arquivo de configuração precisa ser acessível ou legível para a "apigee" usuário.

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

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

Para instalar o portal de API BaaS:

  1. Instalar o utilitário de configuração da Apigee Apigee no nó usando a Internet ou não procedimento Consulte Instalar a configuração da Apigee do Edge 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 do BaaS da API.
    O arquivo de configuração precisa ser acessível ou legível para a "apigee" usuário.

    O instalador inicia o servidor da Web Nginx e conclui o portal da API BaaS configuração do Terraform.
  3. A próxima etapa depende da instalação.
    1. Se você tiver um balanceador de carga à frente dos nós da pilha Portal ou da pilha, a próxima seção descreve como configurar o BaaS de API para os balanceadores de carga.
    2. Se você não tiver um balanceador de carga na frente dos nós da pilha Portalor, faça a integração uma organização, conforme descrito abaixo em Integração uma nova organização.

Anote o URL do portal da API BaaS. Esse é o URL que você insere no navegador para acessar o Interface do usuário do portal de APIs BaaS.

Configurar Nós de BaaS de API para um balanceador de carga de pilha ou portal

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

  • Incluir um URL nas respostas de solicitações da API BaaS.
  • Adicionar links em modelos de e-mail ao redefinir uma senha ou enviar outros notificações.
  • redirecionamento de usuários para páginas específicas do portal

Se você usar um balanceador de carga na frente dos nós de 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 da carga. de carga. Se o balanceador de carga estiver configurado para usar TLS, utilize o protocolo HTTPS. Você só precisa incluir a porta se estiver usando uma porta não padrão, ou seja, algo diferente da porta. 80 para HTTP e porta 443 para HTTPS.

Também é preciso definir a seguinte propriedade em /opt/apigee/customer/application/portal.properties se use um balanceador de carga na frente dos nós da pilha:

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

Substitua http://localhost:8080 pelo URL da de carga HTTP(S) externo global para a 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 de carga HTTP(S) externo global. Se o balanceador de carga estiver configurado para usar TLS, utilize o protocolo HTTPS. Você só precisa incluir a porta se estiver usando uma porta não padrão, ou seja, algo diferente porta 80 para HTTP e porta 443 para HTTPS.

Depois de editar usergrid.properties e portal.properties:

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

    Observação:ao reiniciar os nós da pilha de BaaS, faça isso na mesma ordem listados em BAAS_CLUSTER_SEEDS. BAAS_CLUSTER_SEEDS lista no máximo dois das nós da pilha. Depois de reiniciar esses dois nós em ordem, você pode reiniciar os demais nós em qualquer ordem.

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

Integrar uma nova organização

A integração é o processo de criar uma organização e um administrador da organização. Depois criar a organização e o administrador dela, faça login no portal da API BaaS e fazer solicitações à API REST 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 da organização. No entanto, depois de criar organização, é possível adicionar outros administradores que podem ser duplicados em vários 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ê precisa inserir todas as informações que você omitir 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:

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

    Observação: o IP é o endereço IP/nome do host externo da máquina do portal. Garanta essa porta está aberta.
  4. Quando a tela de login do portal aparecer, 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 BaaS

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

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

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

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

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