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

Portal de serviços para desenvolvedores v. 4.16.09

Antes da instalação, verifique se:

  • 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. Confira a lista de versões compatíveis aqui.
  • O Yum está instalado.
  • Fazer backup das instalações atuais. Se você tiver modificado qualquer código no núcleo do Drupal ou em qualquer módulo não personalizado, as modificações serão substituídas. Isso inclui, entre outras coisas, qualquer mudança que você tenha feito no .portfólio. Você deve presumir que tudo fora do diretório /sites é de propriedade do Drupal. Uma exceção a essa regra é o robots.txt. Se o arquivo existir na raiz da Web, ele será preservado. Antes de continuar com a instalação, faça um backup de todo o diretório raiz da Web do Drupal. O local de instalação padrão é /var/www/html, mas você pode ter alterado no momento da instalação. Depois de executar as etapas de instalação descritas abaixo, é possível restaurar as personalizações do backup.

Siga estas etapas para instalar o portal do Channel Services para desenvolvedores.

1. Instalar o pacote do Channel Services para desenvolvedores

Acesse http://community.apigee.com/content/apigee-customer-support e selecione "Login no portal de suporte" para solicitar o arquivo .tar do Channel Services para desenvolvedores de duas maneiras:

  • Peça acesso ao diretório de download do Edge para a nuvem privada.
  • Solicite um URL para o arquivo .tar do Channel Services para desenvolvedores.

2. 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} https://{hostname}:8080/v1/organizations/{ORGNAME}

Em que EMAIL e SENHA são o endereço de e-mail ORG e a senha do administrador, como EMAIL e EMAIL}:{PASSWORD}

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 o comando for bem-sucedido, este comando retornará uma resposta semelhante a esta:
{
"createdAt" : 1348689232699," "createBy", " "
" "createBy" "físcar









3. 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

Para o CentOS e o Red Hat Enterprise Linux (AOSP), remova os pacotes PHP usando o seguinte comando:

yum remove <package-name>

4. Instalar o Developer Channel Services usando o script de instalação automatizada

Use um dos procedimentos a seguir para instalar o portal, dependendo se você está instalando em um servidor com ou sem uma conexão de Internet.

Em um servidor com conexão à Internet:

Para instalar o Developer Channel Services em um servidor com conexão de Internet, faça o seguinte:

  1. Faça login no servidor como raiz ou superusuário.
  2. Crie um diretório para os arquivos de instalação, como portal.
  3. CD para o novo diretório portal e faça o download do arquivo DeveloperServices_x.y.z.tar do Developer Channel Services, em que x.y.z corresponde ao número da versão do portal.

    É possível fazer o download de um arquivo do link enviado pela Apigee em um navegador ou copiando-o e adicionando-o ao seguinte comando cURL:
    > curl -kOL <paste link here>
  4. Extraia o conteúdo do arquivo .tar do Developer Channel Services usando o comando:
    > tar -xvf <tar file>
  5. CD para DeveloperServices-4.x.y.z.
  6. Execute o script de instalação usando o seguinte comando:
    > ./networked-install.sh
  7. Responda às solicitações.

Em um servidor sem conexão com a Internet:

Primeiro, crie um script de instalação sem rede em um sistema com conexão de Internet:

  1. Faça login em um sistema com uma conexão de Internet como raiz ou como superusuário.
  2. Crie um diretório para os arquivos de instalação, como portal_tar.
  3. CD para o diretório portal_tar e faça o download do arquivo DeveloperServices_x.y.z.tar do Developer Channel Services, em que x.y.z corresponde ao número da versão do portal.
  4. Extraia o conteúdo do arquivo .tar do Developer Channel Services usando o comando:
    > tar -xvf <tar file>
  5. CD para DeveloperServices-4.x.y.z.
  6. Crie o arquivo .tar.gz do portal usando o comando:
    > ./non-networked-install.sh

Um novo arquivo .tar.gz para a instalação sem rede é criado.

Para instalar o Developer Channel Services em um servidor sem conexão de Internet, siga estas etapas:

      1. Faça login no servidor como raiz ou superusuário.
      2. Crie um diretório para os arquivos de instalação, como portal.
      3. CD para o diretório do portal.
      4. Copie o arquivo .tar.gz que você criou para a instalação sem rede (no procedimento acima) no diretório do portal.
      5. Extraia o conteúdo do arquivo .tar.gz usando o comando:
        > tar -xvf <tar file>
      6. CD para o diretório criado pelo comando tar.
      7. Defina as permissões no script install-from-rpm-bundle.sh:
        > chmod 755 install-from-rpm-bundle.sh
      8. Execute o script install-from-rpm-bundle.sh usando o comando:
        > ./install-from-rpm-bundle.sh
      9. Responda às solicitações.

      5. Configurar seu portal do desenvolvedor

      Grande parte da configuração do portal é feita sem exigir sua interação, como a instalação do módulo Drupal e a criação de conteúdo padrão. Você precisa configurar o banco de dados, o endpoint do Edge e criar um novo usuário administrador.

      Para configurar seu portal do desenvolvedor:

      1. Navegue até o URL do servidor em um navegador, como:
        http://localhost. Ou, se você tiver um IP ou DNS específico configurado, acesse http://IP_address ou http://DNS_name.

        Você será redirecionado para a página de configuração do banco de dados de perfis da Apigee.

        Observação: normalmente, você já terá configurado um nome do host e o registrado no servidor DNS para não precisar usar http://localhost.
      2. Configure a conexão com o banco de dados. Se o banco de dados estiver em uma máquina remota, expanda a seção Opções avançadas, insira as informações de conexão nela e selecione Salvar e continuar.
      3. Configure a conexão com o endpoint da Apigee inserindo as informações a seguir e selecione Salvar.
        Para mais informações sobre esses valores, consulte "Informações necessárias antes de iniciar a instalação" em Requisitos do portal de serviços para desenvolvedores.
        1. Organização da API Management
        2. URL do endpoint da API Management
        3. Usuário autenticado do endpoint
        4. Senha de usuários autenticados
      4. Configure o usuário administrador inserindo as informações a seguir e selecione "Salvar". O Drupal cria um usuário administrador chamado "admin" por padrão. Portanto, não use "admin" como nome de usuário.
        Se você pular esta etapa, ainda poderá usar o Drush para criar um administrador, conforme descrito abaixo em 4. Crie um usuário administrador.
        1. Nome e sobrenome do desenvolvedor
        2. Nome de usuário no portal do desenvolvedor
        3. Senha
        4. Endereço de e-mail
      5. Após a conclusão da instalação, defina as permissões no arquivo settings.php:
        > chmod 640 /var/www/html/sites/default/settings.php
      6. Navegue até a página inicial do portal em http://localhost/ ou acesse o nome DNS do seu portal.
      7. Faça login no portal usando as credenciais de administrador.

      6. Criar um usuário administrador (opcional)

      Use o Drush para criar um usuário administrativo para sua instalação do Channel Services para desenvolvedores. O Drupal cria automaticamente um usuário administrador chamado "admin" por padrão. Portanto, não use "admin" como o nome de usuário.

      1. CD para o diretório drupal_root/sites/default. O local padrão do diretório raiz do Drupal é /var/www/html:
        > cd <drupal_root>/sites/default
      2. Verifique se você tem permissões de gravação nos arquivos Drupal particulares:
        > drush vget file_private_path

        Esse comando retorna o caminho para os arquivos Drupal particulares, por exemplo:
        file_private_path: 'sites/default/private'

        Corresponde a /var/www/html/sites/default/private/. Use o comando a seguir para garantir que esse diretório possa ser gravado pelo proprietário e pelo grupo:
        chmod -R g+w dirPathAndName
        chmod -R o+r dirPathAndName
      3. Digite os seguintes comandos para criar um usuário administrador, substituindo os comandos em “< >” pelos seus valores:
        > drush user-create <username> --mail="<email-address>" --password="<password>"
        > drush user-add-role Administrator <username>
      4. Faça login no portal do desenvolvedor como administrador usando o nome de usuário e a senha especificados acima.

      5. Definir a senha raiz do MySQL

      Se você instalou o MySQL como parte da instalação do portal, o script de instalação deixará a senha raiz do MySQL definida com o valor padrão, que fica em branco.

      Use o seguinte comando para definir a senha raiz:

      > mysqladmin -u root password NEWPASSWORD
      

      Se você já tiver definido a senha raiz e quiser alterá-la, use o seguinte comando:

      > mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD
      

      Você também precisa atualizar a senha no arquivo /var/www/html/sites/default/settings.php.

      6. 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
      

      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.

      7. Implantar em um servidor de produção (opcional)

      Se você estiver implantando o portal em um servidor de produção, execute outras etapas de segurança, incluindo:

      1. Execute o script a seguir para proteger a instalação do MySQL:
        > /usr/bin/mysql_secure_installation

        Esse script define a senha raiz e oferece a opção de restringir o acesso raiz apenas ao localhost e remover os bancos de dados de teste e usuários anônimos criados por padrão. A execução desse script é altamente recomendável para servidores de produção.
      2. Ative e configure o SELinux, se exigido pelas políticas corporativas.

      8. 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, por isso, 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.

      9. Instalar mod_ssl para oferecer suporte a HTTPS (opcional)

      O módulo mod_ssl é usado pelo servidor HTTP Apache para exibir páginas da Web por HTTPS. Se você quiser usar HTTPS, use o seguinte comando para instalar mod_ssl:

      > yum install mod_ssl
      

      Para mais informações sobre como configurar o portal para usar SSL, consulte http://apigee.com/docs/developer-services/content/using-ssl-portal.

      10. 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 saber mais sobre como instalar o Edge e o SmartDocs, consulte Instalar o SmartDocs.

      Para mais informações sobre SmartDocs, consulte Como usar SmartDocs para documentar APIs.

      11. 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.

      Configurar um nome do host

      Se você não configurar um nome do host no servidor DNS, vai poder acessar o site 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 no arquivo settings.php do Portal do desenvolvedor, que, por padrão, fica no diretório /var/www/html/sites/default.