Esta página foi traduzida pela API Cloud Translation.

Instalação do portal de serviços para desenvolvedores

Edge para nuvem privada v. 4.17.01

Antes de instalar, verifique se:

Você instala o Postgres antes de instalar o portal. É possível instalar o Postgres como parte da instalação do Edge ou instalar o Postgres autônomo para uso no portal.
- Se você instalar o Postgres de forma independente, ele poderá estar no mesmo nó do portal.
- Se você estiver se conectando ao Postgres instalado como parte do Edge e ele estiver configurado no modo mestre/em espera, especifique o endereço IP do servidor Postgres mestre.
Você está realizando a instalação na versão de 64 bits de uma versão com suporte do Red Hat Enterprise Linux, CentOS ou Oracle. Consulte a lista de versões compatíveis em Software e versões compatíveis.
O Yum está instalado.

Visão geral da instalação

Depois de instalar o utilitário apigee-setup do Edge em um nó, use esse utilitário para instalar o portal 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 que contém as informações sobre a instalação. Se o arquivo de configuração estiver sem informações necessárias, o utilitário apigee-setup vai solicitar que você as insira na linha de comando.

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

Por exemplo, use o seguinte comando para instalar o portal:

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

Consulte Instalar o utilitário apigee-setup do Edge para mais informações.

Como criar um arquivo de configuração

Confira abaixo um exemplo de arquivo de configuração silenciosa para uma instalação do portal. Edite esse arquivo conforme necessário para sua configuração. Use a opção -f para setup.sh para incluir esse arquivo.

Observação:não defina DEVPORTAL_ADMIN_USERNAME=admin. A conta de usuário admin é criada por padrão. Se especificado, uma mensagem de erro será retornada solicitando que você configure um nome de usuário diferente.

IP1=IPorDNSnameOfNode

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

# Specify the name of the portal database in Postgres. 
PG_NAME=devportal 

# Specify the Postgres admin credentials. 
# The portal connects to Postgres by using the 'apigee' user. 
# If you changed the Postgres password from the default of 'postgres' 
# then set PG_PWD accordingly. 
# If connecting to a Postgres node installed with Edge, 
# contact the Edge sys admin to get these credentials. 
PG_USER=apigee 
PG_PWD=postgres 

# The IP address of the Postgres server. 
# If it is installed on the same node as the portal, specify that IP. 
# If connecting to a remote Postgres server,specify its IP address. 
PG_HOST=$IP1 

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# You must configure the SMTP server used by the portal. 
# The properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. Testar sua conexão com o Apigee Edge

Para testar a conexão com o servidor de gerenciamento de borda, execute o seguinte comando cURL em um prompt de comando no servidor do portal:

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

Em que EMAIL e PASSWORD são o endereço de e-mail e a senha do administrador de ORGNAME.

Especifique o nome do host e o número da porta específicos da sua instalação do Edge. A porta 8080 é a porta padrão usada pelo Edge. Se você estiver se conectando a uma organização na nuvem, o URL da solicitação será https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Se for bem-sucedido, o comando vai retornar uma resposta semelhante a esta:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Remover versões anteriores a 7.0 do PHP

O script de instalação verifica se há versões anteriores à 7.0 do PHP no sistema antes de iniciar a instalação. Se houver versões anteriores ao PHP 7.0, a seguinte mensagem de aviso será exibida:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Para o CentOS e o RedHat Enterprise Linux (RHEL), remova os pacotes PHP usando o seguinte comando:

yum remove <package-name>

3. Instalar o Postgres

Para instalar o portal, é necessário ter o Postgres instalado. É possível instalar o Postgres como parte da instalação do Edge ou instalar o Postgres de forma independente para uso pelo portal.

Se você estiver se conectando ao Postgres instalado como parte do Edge e o Postgres estiver configurado no modo mestre/standby, especifique o endereço IP do servidor mestre do Postgres.
Se você instalar o Postgres de forma independente, ele poderá estar no mesmo nó do portal.

Para informações sobre como instalar o Postgres como parte da instalação do Edge, consulte Instalar componentes do Edge em um nó.

Para instalar o Postgres separadamente:

Instale o utilitário apigee-setup do Edge no nó usando o procedimento com ou sem Internet. Consulte Instalar o utilitário de configuração da Apigee Apigee para mais informações.
Crie um arquivo de configuração para o Postgres, conforme mostrado abaixo:

# O pod e a região do Postgres. Use os valores padrão mostrados abaixo.
MP_POD=gateway
REGION=dc-1

# Defina a senha do Postgres. O valor padrão é "postgres".
PG_PWD=postgres
No prompt de comando, execute o script de configuração para instalar o Postgres:
> /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

A opção "-p pdb" especifica a instalação do Postgres.

O arquivo de configuração precisa ser acessível ou legível pelo usuário "apigee".

4. Instalar o portal

Para instalar o portal:

Instale o utilitário apigee-setup do Edge no nó usando o procedimento de Internet ou não. Consulte Instalar o utilitário apigee-setup do Edge para mais informações.
Verifique se você instalou o Postgres, seja independente ou como parte da instalação do Edge.
No prompt de comando, execute o script de configuração:
> /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

A opção "-p dp" especifica a instalação do portal.

O arquivo de configuração precisa ser acessível ou legível pelo usuário "apigee".
Acesse a página inicial do portal em http://localhost:8079 ou o nome de DNS do portal.
Faça login no portal usando as credenciais de administrador definidas no arquivo de configuração.

5. Verifique se o módulo do gerenciador de atualizações está ativado.

Para receber notificações de atualizações do Drupal, verifique se o módulo gerenciador de atualização do Drupal está ativado. No menu do Drupal, selecione Modules e role a tela para baixo até o módulo Update manager. Se não estiver, ative-a.

Depois da ativação, confira as atualizações disponíveis no item de menu Relatórios > Atualizações disponíveis. Também é possível usar o seguinte comando do Drush:

> drush pm-info update

Execute esse comando no diretório raiz do site. Por padrão, o portal do desenvolvedor é instalado em /opt/apigee/apigee-drupal. Portanto, primeiro altere o diretório para /opt/apigee/apigee-drupal antes de executar o comando. Se você não instalou o portal no diretório padrão, mude para o diretório de instalação.

Use o item de menu Reports > Available Updates > Settings para configurar o módulo para enviar um e-mail quando as atualizações estiverem disponíveis e definir a frequência de verificação de atualizações.

6. Configurar o mecanismo de pesquisa Apache Solr (opcional)

Por padrão, os módulos do Drupal que se conectam ao mecanismo de pesquisa do Apache Solr são desativados quando você instala o portal. A maioria dos portais usa o mecanismo de pesquisa interno do Drupal e, portanto, não exige os módulos do Drupal Solr.

Se você decidir usar o Solr como seu mecanismo de pesquisa, instale o Solr localmente no seu servidor e ative e configure os módulos Drupal Solr no portal.

Para ativar os módulos do Drupal Solr:

Faça login no portal como um usuário com privilégios de administrador ou de criação de conteúdo.
Selecione Módulos no menu do Drupal.
Ative o módulo Apache Solr Framework e o módulo Apache Solr Search.
Salve as alterações.
Configure o Solr conforme descrito em https://drupal.org/node/1999280.

7. Instalar o SmartDocs (opcional)

O SmartDocs permite documentar suas APIs no portal dos Serviços do desenvolvedor de um modo que torna a documentação da API totalmente interativa. No entanto, para usar o SmartDocs com o portal, primeiro é necessário instalar o SmartDocs no Edge.

Se você estiver conectando o portal a uma instalação do Edge Cloud, o SmartDocs já estará instalado e nenhuma outra configuração será necessária.
Se você estiver conectando o portal a um Edge para instalação de nuvem privada, verifique se o SmartDocs está instalado no Edge. Para mais informações sobre como instalar o Edge e o SmartDocs, consulte Instalar o SmartDocs.

Você também precisa ativar o SmartDocs no portal. Para mais informações sobre SmartDocs, consulte Como usar SmartDocs para documentar APIs.

8. E agora?

Depois de instalar o portal de serviços para desenvolvedores, você vai precisar configurá-lo e personalizá-lo de acordo com seus requisitos específicos. A documentação no site da Apigee contém todas as informações sobre como configurar, estilizar e gerenciar um portal. Acesse a documentação em http://apigee.com/docs/developer-services/content/what-developer-portal.

A tabela a seguir lista algumas das tarefas mais comuns que você executa após a instalação e inclui links para a documentação da Apigee, onde você pode encontrar mais informações:

Tarefa	Descrição
Como personalizar o tema	O tema define a aparência do portal, incluindo cores, estilo e outros aspectos visuais.
Personalizar a aparência	A página inicial inclui o menu principal, a mensagem de boas-vindas, o cabeçalho, o rodapé e o título.
Adicionar e gerenciar contas de usuário	O processo de registro controla como os novos desenvolvedores registram uma conta no portal. Por exemplo, os novos desenvolvedores têm acesso imediato ao portal ou precisam ser verificados por um administrador? Esse processo também controla como um administrador do portal é notificado quando uma nova conta é criada.
Configurar e-mail	O portal envia e-mails em resposta a determinados eventos. Por exemplo, quando um novo desenvolvedor se registra no portal e perde a senha.
Adicionar e gerenciar contas de usuário	Adicione uma página de Termos e Condições que os desenvolvedores precisam aceitar antes de acessar o portal.
Adicionar e gerenciar contas de usuário	O portal implementa um modelo de autorização baseado em função. Antes de permitir que os desenvolvedores se registrem, defina as permissões e funções usadas pelo portal.
Adicionar postagens de blogs e fóruns	O portal tem suporte integrado para blogs e fóruns com tópicos. Defina as permissões necessárias para acessar, adicionar, editar e excluir postagens de blogs e fóruns.
Verificar se você está fazendo backups do banco de dados	Faça backup do banco de dados do Drupal. Como cada instalação é diferente, cabe a você determinar a melhor forma de fazer backup do banco de dados. Observação: o módulo de backup e migração não é compatível com bancos de dados do Postgres. Consulte também Como fazer um backup.
Configurar um nome do host	Se você não configurar um nome de host no servidor DNS, poderá acessar o site pelo endereço IP do servidor. Se você quiser usar um nome de host, configure o DNS para o servidor, que deve funcionar corretamente sem nenhuma outra configuração em uma configuração básica. Se você configurar um balanceador de carga ou receber URLs incorretos no site por algum outro motivo, defina $base_url no arquivo settings.php do portal para desenvolvedores, que fica no diretório /opt/apigee/apigee-drupal/sites/default por padrão.
Desenvolvimento personalizado	Você também pode estender os recursos do portal com um código personalizado fora do tema. Para fazer isso, crie seu próprio módulo do Drupal conforme descrito nos tópicos de desenvolvimento de módulos do Drupal e coloque o módulo no diretório `/sites/all/modules`.