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

Edge para nuvem privada v4.18.01

Antes da instalação, 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 autônomo para uso pelo portal.
    • Se você instalar o Postgres autônomo, ele poderá estar no mesmo nó que o portal.
    • Se você estiver se conectando ao Postgres instalado como parte do Edge, e o Postgres estiver configurado no modo mestre/de espera, especifique o endereço IP do servidor mestre do Postgres.
  • Você está executando a instalação em uma 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 Softwares e versões compatíveis.
  • O Yum está instalado.

O instalador inclui apenas módulos de contribuição com Drupal que são exigidos pelo portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal). Para saber mais sobre como instalar outros módulos, consulte Estender o Drupal 7.

Visão geral da instalação

Depois de instalar o utilitário Edge apigee-setup em um nó, use-o para instalar o portal no nó. O utilitário apigee-setup tem o 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 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 o portal:

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

Consulte Instalar o utilitário de configuração da Apigee do Edge para saber mais.

Descontinuação 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 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".

Como criar um arquivo de configuração

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 incluir o 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=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 

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

1. Testar sua conexão com o Apigee Edge

Teste sua conexão com o servidor de gerenciamento de borda executando 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}

ou

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.

Informe o nome do host e o número da porta específicos para a 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, esse comando 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 do PHP anteriores à 7.0

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

3. Instalar o Postgres

Para fazer a instalação no portal, o Postgres precisa estar instalado. É possível instalar o Postgres como parte da instalação do Edge ou instalar o Postgres autônomo para uso pelo portal.

  • Se você estiver se conectando ao Postgres instalado como parte do Edge, e o Postgres estiver configurado no modo mestre/de espera, especifique o endereço IP do servidor mestre do Postgres.
  • Se você instalar o Postgres autônomo, 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 autônomo:

  1. Instale o utilitário apigee-setup do Edge no nó usando um procedimento da Internet ou não. Consulte Instalar o utilitário de configuração da Apigee do Edge para saber mais.
  2. Crie um arquivo de configuração para o Postgres, conforme mostrado abaixo:
    # 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
  3. 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 Postgre. O arquivo de configuração precisa estar acessível ou legível para o usuário "apigee".

4. Instalar o portal

Para instalar o portal:

  1. Instale o utilitário apigee-setup do Edge no nó usando um procedimento da Internet ou não. Consulte Instalar o utilitário de configuração da Apigee do Edge para saber mais.
  2. Verifique se o Postgres foi instalado, seja o Postgres autônomo ou como parte da instalação do Edge.
  3. 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 estar acessível ou legível para o usuário "apigee".

  4. Navegue até a página inicial do portal em http://localhost:8079 ou acesse o nome DNS dele.
  5. Faça login no portal usando as credenciais de administrador definidas no arquivo de configuração para garantir que o portal esteja sendo executado corretamente.
  6. Selecione Relatórios > Relatório de status no menu Drupal para garantir que você possa ver o status atual do portal.

5. Verificar 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 do gerenciador de atualizações do Drupal está ativado. No menu do Drupal, selecione Modules e role para baixo até o módulo Update manager. Se não estiver ativado, ative-o.

Depois de ativado, é 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

Execute este comando no diretório raiz do site. Por padrão, o Portal do desenvolvedor é instalado em /opt/apigee/apigee-drupal/wwwroot. Portanto, 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 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 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 Drupal e, portanto, não exige os módulos 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 Drupal Solr:

  1. Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Modules no menu do Drupal.
  3. Ative o módulo Apache Solr Framework e o módulo Apache Solr Search.
  4. Salve as mudanças.
  5. 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 serviços para desenvolvedores de uma maneira que torne a documentação da API totalmente interativa. No entanto, para usar o SmartDocs com o portal, primeiro você precisa 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. Configurar o módulo de atualização do JQuery para instalações que não são na Internet (opcional)

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

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

  1. Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Configuration > Development > JQuery Update no menu do Drupal.
  3. Clique em Performance no painel de navegação à esquerda.
  4. No menu suspenso da CDN da IU do JQuery e JQuery, selecione Nenhum.
  5. Clique em Salvar configuração.

9. E agora?

As próximas etapas depois de instalar o portal de serviços para desenvolvedores são 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 é possível encontrar mais informações:

Tarefa Descrição

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 e-mail

O portal envia e-mails em resposta a determinados eventos. Por exemplo, quando um novo desenvolvedor se inscreve no portal e quando um desenvolvedor 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 poder acessar o portal.

Adicionar e gerenciar contas de usuário

O portal implementa um modelo de autorização com base em funções. Antes de permitir que os desenvolvedores se registrem, defina as permissões e os papéis usados pelo portal.

Adicionar postagens de blog e fórum

O portal tem suporte integrado para blogs e fóruns com conversas agrupadas. Defina as permissões necessárias para acessar, adicionar, editar e excluir postagens do blog e do fórum.

Verifique se você está fazendo backups do banco de dados

Não se esqueça de fazer 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 Backup e migração não é compatível com os bancos de dados do Postgres.

Consulte também Como fazer um backup.

Configurar um nome do host

Se você não configurar um nome do host no servidor DNS, poderá acessar o site a qualquer momento pelo endereço IP do servidor. Se quiser usar um nome de host, configure o DNS para o servidor, que funcionará corretamente sem qualquer outra configuração em uma configuração básica.

Se você configurou um balanceador de carga ou está recebendo URLs incorretos no seu site por algum outro motivo, defina $base_url para o Drupal seguindo estas etapas:

  1. Crie o diretório /opt/apigee/data/apigee-drupal-devportal/sites/default/includes, se ele não existir.
  2. Crie um arquivo chamado settings.php nesse diretório.
  3. Adicione o código abaixo 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’;
    
  4. Altere a última linha $base_url para o nome do host do seu site.
  5. Salve o arquivo.

Qualquer outra configuração de /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php pode ser colocada nesse arquivo.

Para mais informações sobre a propriedade $base_url, consulte:

Desenvolvimento personalizado Você também pode ampliar os recursos do portal com um 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 do Drupal e coloque-o no diretório /sites/all/modules.