Esta página foi traduzida pela API Cloud Translation.

Instalar o portal

Edge para nuvem privada v4.18.05

Antes de instalar o portal Apigee Developer Services (ou simplesmente o portal), verifique se:

Instale o Postgres antes de instalar o portal. É possível instalar o Postgres como parte da instalação do Edge ou instalar o Postgres independente para uso pelo portal.
- Se você instalar o Postgres independente, ele poderá estar no mesmo nó que o 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 mestre do Postgres.
Você está executando a instalação na versão de 64 bits de uma versão compatível do Red Hat Enterprise Linux, CentOS ou Oracle. Consulte a lista de versões compatíveis em Software compatível e versões compatíveis.
O Yum está instalado.

O instalador inclui apenas módulos fornecidos pelo Drupal que são exigidos pelo portal do Apigee Developer Services (ou simplesmente o portal). Para ver informações sobre como instalar outros módulos contribuídos, consulte Estender o Drupal 7.

Visão geral da instalação

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

Testar sua conexão
Remover versões do PHP anteriores à 7.0
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 JQuery

Suspensão de uso da propriedade SMTPSSL

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

Agora, use 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

Veja abaixo um exemplo de arquivo de configuração silenciosa para uma instalação de portal. Edite esse arquivo conforme necessário para sua configuração. Use a opção -f para setup.sh para incluir esse 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

Teste sua conexão entre o servidor em que o portal será instalado e o servidor de gerenciamento do Edge executando 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 é o padrão usado 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 retornará uma resposta semelhante à seguinte:

{
  "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 à 7.0 do PHP

O script de instalação verifica se há versões do PHP anteriores à 7.0 no sistema antes de iniciar a instalação. Se houver versões do PHP anteriores à 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 de que o PHP está instalado no servidor, use o seguinte comando:

rpm -qa | grep -i php

3. Instalar o Postgres

É necessário instalar o Postgres para instalar o portal. É possível instalar o Postgres como parte da instalação do Edge ou instalar o Postgres independente para uso pelo 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 mestre do Postgres.
Se você instalar o Postgres independente, ele poderá estar no mesmo nó que o 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 independente:

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

Crie um arquivo de configuração do Postgres, como 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
Instale o Postgres, seja por conta própria 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 ser acessível ou legível pelo usuário "apigee".
- -p dp instrui o script setup a instalar o portal.

Para verificar se a instalação do portal foi bem-sucedida:

Navegue até a página inicial do portal em http://localhost:8079 ou para o nome DNS do seu portal.
Faça login no portal usando as credenciais de administrador definidas no arquivo de configuração.
Selecione Reports > Status Report no menu do Drupal para verificar se você pode ver o status atual do portal.
Verifique se a conexão do 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ê estará pronto. Se a conexão falhar, continue.
3. Verifique o endpoint e as configurações de autenticação:
  - URL do endpoint da API de gerenciamento: 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 pelo 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 definições do 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 a 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 que tenha o papel de administrador da organização.
4. Depois de se conectar ao servidor de gerenciamento, clique no botão Salvar configuração na parte inferior da página para salvar as alterações.

5. Verificar se o módulo Gerenciador de atualizações está ativado

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

Depois de ativar, é possível ver as atualizações disponíveis usando o item de menu Relatórios > Atualizações disponíveis. Você também pode usar o seguinte comando Drush:

drush pm-info update

Você precisa executar esse comando a partir do diretório raiz do site. Por padrão, o portal é instalado em /opt/apigee/apigee-drupal/wwwroot. Portanto, mude 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 Relatórios > Atualizações disponíveis > Configurações para configurar o módulo para enviar um e-mail quando as atualizações estiverem disponíveis e definir a frequência para verificação de atualizações.

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

Por padrão, os módulos 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 interno de pesquisa do Drupal e, portanto, não requer os módulos do Drupal Solr.

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

Para ativar os módulos do Drupal Solr:

Faça login no seu portal como um usuário com privilégios de administrador ou de criação de conteúdo.
Selecione Modules no menu do Drupal.
Ative os módulos Apache Solr Framework e Apache Solr Search.
Salve as mudanças.
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 modo a tornar 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 como instalar o Edge e o SmartDocs, consulte Instalar o SmartDocs.

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

8. Configurar o módulo JQuery Update para instalações que não são da Internet (opcional)

Se você instalar e usar o módulo de atualização do JQuery em uma instalação que não seja da Internet, será necessário 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 na Internet, ela tentará acessar a CDN e causará atrasos no carregamento da página. Para mais informações sobre o módulo JQuery Update, consulte https://www.drupal.org/project/jquery_update.

Para configurar o módulo JQuery Update para usar a versão local do JQuery:

Faça login no seu 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.
Na lista suspensa JQuery e JQuery UI CDN, selecione None.
Clique em Salvar configuração.

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 é possível encontrar mais informações:

Tarefa	Descrição
Personalizar o tema	O tema define a aparência do portal, incluindo cores, estilos 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 terem permissão para acessar o portal.
Adicionar e gerenciar contas de usuário	O portal implementa um modelo de autorização baseado em papéis. Antes de permitir que os desenvolvedores se registrem, defina as permissões e os papéis usados pelo portal.
Adicionar postagens do blog e do fórum	O portal tem suporte integrado para blogs e fóruns. Defina as permissões necessárias para ver, adicionar, editar e excluir postagens do blog e do fórum.
Verificar se você está fazendo backups do banco de dados	Verifique se você está fazendo backup do banco de dados do Drupal. Observe que, como cada instalação é diferente, cabe a você determinar a melhor maneira de fazer o backup do banco de dados. Observação: o módulo Backup e Migrate não é compatível com bancos de dados Postgres. Consulte também Como fazer um backup.
Configurar um nome de host	Se você não configurar um nome do host no seu servidor DNS, poderá acessar o site por meio do endereço IP do servidor a qualquer momento. Se você quiser usar um nome do host, poderá configurar o DNS para o servidor, o que deve funcionar corretamente sem qualquer outra configuração básica. Se você configurar um balanceador de carga ou estiver recebendo URLs incorretos no site por algum outro motivo, defina `$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’; Altere a última linha `$base_url` para ser o nome do host do seu site. Salve o arquivo. É possível colocar outras configurações de `/opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php` nesse arquivo. Para mais informações sobre a propriedade `$base_url`, consulte: https://codeburst.io/security-for-drupal-and-related-server-software-3c979b041595 (em inglês) https://www.drupal.org/node/1992030 (link em inglês)
Desenvolvimento personalizado	Também é possível ampliar os recursos do portal com código personalizado fora do seu tema. Para fazer isso, crie seu próprio módulo do Drupal, conforme descrito nos tópicos de desenvolvimento de módulos, e coloque-o no diretório `/sites/all/modules`.