Esta página foi traduzida pela API Cloud Translation.

Instalar o portal

Edge para nuvem privada v4.19.01

Antes de instalar o portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal), 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 de forma independente para uso pelo 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 o Postgres estiver configurado no modo mestre/standby, especifique o endereço IP do servidor mestre do Postgres.
Você está executando 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.

O instalador inclui apenas módulos do Drupal que são necessários para o portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal). Para informações sobre como instalar outros módulos contribuídos, consulte Como estender o Drupal 7.

Visão geral da instalação

Para instalar o portal, siga estas etapas. Cada uma dessas etapas é descrita em mais detalhes nas seções a seguir.

Testar sua conexão
Remover versões anteriores a 7.0 do PHP
Instalar o Postgres
Instalar o portal
Verificar se o gerenciador de atualizações está ativado
(Opcional) Configurar o Apache Solr
(Opcional) Instalar o SmartDocs
(Opcional) Configurar o JQuery

Desatualização da propriedade SMTPSSL

Em versões anteriores, você usava a propriedade SMTPSSL para definir o protocolo usado pelo servidor SMTP conectado ao portal. Essa propriedade foi descontinuada.

Agora você usa a propriedade SMTP_PROTOCOL, em vez da propriedade SMTPSSL, para definir o protocolo usado pelo servidor SMTP conectado ao portal. Os valores válidos são: "standard", "ssl" ou "tls".

Criar um arquivo de configuração do portal

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 e inclua este arquivo.

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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

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

# Optionally configure the SMTP server used by the portal.
# If you do, 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

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# 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=YOUR_EMAIL_PASSWORD

1. Testar sua conexão com o Apigee Edge

Para testar a conexão entre o servidor em que você vai instalar o portal e o servidor de gerenciamento de borda, execute o seguinte comando curl 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, curl 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 do PHP anteriores à 7.0

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

Remova os pacotes PHP usando o seguinte comando:

yum remove package_name

Se você não tiver certeza se o PHP está instalado no servidor, use o seguinte comando:

rpm -qa | grep -i php

O portal usa a versão 4.18.01-0.0.49 do PHP. Não é necessário corresponder ao número da versão do Apigee Edge para nuvem privada.

3. Instalar o Postgres

O portal exige que o Postgres seja instalado antes de você instalar o portal. É 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 de forma independente:

Instale o utilitário apigee-setup do Edge no nó usando o procedimento de Internet ou sem Internet. Consulte Instalar o utilitário de configuração da Apigee Apigee para mais informações.

Crie um arquivo de configuração do Postgres, conforme mostrado no exemplo a seguir:

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

# The pod and region of Postgres. Use the default values shown below.
MP_POD=gateway
REGION=dc-1

# Set the Postgres password. The default value is '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 postgres_config_file
```
A opção -p pdb especifica a instalação do Postgre. O arquivo de configuração precisa ser acessível ou legível pelo usuário "apigee".

4. Instalar o portal

Antes de instalar o portal, verifique se você fez o seguinte, conforme descrito em 3. Instale o Postgres:

Instalar o utilitário Edge apigee-setup no nó do portal
Instalar o Postgres, seja independente ou como parte da instalação do Edge

Para instalar o portal:

No prompt de comando, execute o script setup:
```
/opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
```
Em que:
- configFile é o arquivo de configuração do portal, conforme descrito em Criar um arquivo de configuração do portal.
  O arquivo de configuração precisa estar acessível ou legível para o usuário da "apigee".
- -p dp instrui o script setup a instalar o portal.

Para verificar se a instalação do portal foi concluída:

Acesse a página inicial do portal em http://localhost:8079 ou o nome DNS do seu portal.
Faça login no portal usando as credenciais de administrador definidas no arquivo de configuração do portal.
Selecione Reports > Status Report no menu do Drupal para conferir o status atual do portal.
Verifique se a conexão com o servidor de gerenciamento foi bem-sucedida. Se não foi:
1. Navegue até a página de configuração de conexão do portal (por exemplo, http://portal_IP:8079/admin/config/devconnect).
2. Clique no botão Testar conexão. Se a conexão for bem-sucedida, você já pode começar. Se a conexão falhar, continue.
3. Verifique as configurações de endpoint e autenticação:
  - URL do endpoint da API Management:verifique se o protocolo (HTTP ou HTTPS), o nome do IP ou DNS e o número da porta estão corretos. Por exemplo:
```
http://10.10.10.10:8080/v1
```
  - Usuário autenticado do endpoint:o nome de usuário do administrador da organização.
  - Senha do usuário autenticado: a senha do administrador da organização.
  Os valores padrão refletem as configurações no arquivo de configuração do portal que você criou durante o processo de instalação.
  
  Esses valores precisam corresponder aos valores ms_IP_or_DNS, email e password usados na etapa 1: testar sua conexão com o Apigee Edge. O nome de usuário e a senha também precisam corresponder aos valores das propriedades USER_NAME e USER_PWD no arquivo de configuração de integração ou às credenciais de qualquer usuário com a função de administrador da organização.
4. Depois de se conectar ao servidor de gerenciamento, clique no botão Salvar configuração na parte de baixo da página para salvar as mudanças.

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.

Depois de ativar, você pode conferir as atualizações disponíveis usando o item de menu Reports > Available Updates. 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 é instalado em /opt/apigee/apigee-drupal/wwwroot. Portanto, primeiro altere o diretório para /opt/apigee/apigee-drupal/wwwroot 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 > Disponível Atualizações > Configurações para configurar o módulo para enviar um e-mail a você 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 Drupal que se conectam ao mecanismo de pesquisa 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 mecanismo de pesquisa, instale-o localmente no servidor e ative e configure os módulos do Drupal Solr no portal.

Para ativar os módulos 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 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 uma instalação do Edge para nuvem privada, verifique se o SmartDocs está instalado no Edge. Para saber mais sobre a instalação do Edge e do SmartDocs, consulte Instalar o SmartDocs.

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

8. Configurar o módulo de atualização do JQuery para instalações sem Internet (opcional)

Se você instalar e usar o módulo JQuery Update em uma instalação que não seja da Internet, precisará configurar o módulo para usar a versão local do JQuery. Se você configurar o módulo para usar uma CDN em uma instalação que não seja pela Internet, ele tentará acessar a CDN e causar atrasos no carregamento da página. Para mais informações sobre o módulo de atualização do jQuery, consulte https://www.drupal.org/project/jquery_update.

Para configurar o módulo de atualização do JQuery para usar a versão local do JQuery:

Faça login no portal como um usuário com privilégios de administrador ou de criação de conteúdo.
Selecione Configuration > Development > JQuery Update no menu do Drupal.
Clique em Desempenho na navegação à esquerda.
No menu suspenso "CDN da interface do JQuery e JQuery", selecione Nenhum.
Clique em Save configuration.

9. Próximas etapas

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.
Como configurar o 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 visualizar, adicionar, editar e excluir postagens de blogs e fóruns.
Verificar se você está fazendo backups do banco de dados	Verifique se você está fazendo backup do banco de dados 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 "Backup and Migrate" não é compatível com bancos de dados do Postgres. Consulte também Como fazer um backup.
Configurar um nome de 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, poderá definir `$base_url` para o Drupal seguindo estas etapas: Crie o diretório `/opt/apigee/data/apigee-drupal-devportal/sites/default/includes`, se ele não existir. Crie um arquivo chamado `settings.php` nesse diretório. Adicione o seguinte ao arquivo `settings.php`: /** * Base URL (optional). * * If Drupal is generating incorrect URLs on your site, which could * be in HTML headers (links to CSS and JS files) or visible links * on pages (such as in menus), uncomment the Base URL statement * below (remove the leading hash sign) and fill in the absolute URL * to your Drupal installation. * * You might also want to force users to use a given domain. * See the .htaccess file for more information. * * Examples: * $base_url = 'http://www.example.com'; * $base_url = 'http://www.example.com:8888'; * $base_url = 'http://www.example.com/drupal'; * $base_url = 'https://www.example.com:8888/drupal'; * * It is not allowed to have a trailing slash; Drupal will add it * for you. */ # $base_url = 'http://www.example.com/'; // NO trailing slash! $base_url = ‘http://www.example.com’; Mude a última linha `$base_url` para ser o nome do host do site. Salve o arquivo. É possível colocar outras configurações de `/opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php` neste arquivo. Para mais informações sobre a propriedade `$base_url`, consulte: https://codeburst.io/security-for-drupal-and-related-server-software-3c979b041595 https://www.drupal.org/node/1992030
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 Drupal conforme descrito nos tópicos de desenvolvimento de módulos do Drupal e coloque o módulo no diretório `/sites/all/modules`.