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

Portal de serviços para desenvolvedores v. 4.16.05

Siga estas etapas para instalar o portal de serviços do canal para desenvolvedores.

Antes de prosseguir 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 talvez você o tenha alterado no momento da instalação. Depois de realizar as etapas de instalação descritas abaixo, você poderá restaurar suas personalizações do backup.

1. Acessar o pacote de serviços do canal para desenvolvedores

Acesse http://community.apigee.com/content/apigee-customer-support e selecione "Login to your Support Portal" para solicitar o arquivo .tar dos serviços do canal do desenvolvedor de uma das duas maneiras:

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

2. Verifique se o sistema atende aos requisitos do sistema

Antes de instalar o portal, seu servidor precisa atender aos seguintes requisitos:

1. Verifique se você está realizando a instalação na 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.
2. Verifique se o Yum está instalado.
3. (Para uma instalação em um servidor sem conexão de Internet) Primeiro, faça o download de todos os arquivos necessários em um servidor com conexão de Internet como um único arquivo .tar.gz. Em seguida, copie esse arquivo .tar.gz para o servidor sem uma conexão de Internet para realizar a instalação.
   1. Faça login em um servidor com uma conexão de Internet como raiz ou superusuário.
   2. Crie um diretório para os arquivos de instalação, como portal_tar.
   3. Acesse o novo diretório e faça o download do arquivo DeveloperServices_x.y.z.tar dos serviços do canal do desenvolvedor, 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
      
      Esse comando faz o download de todos os arquivos necessários e os coloca em um único arquivo .tar.gz. Em seguida, copie esse arquivo .tar.gz para o servidor que não tem conexão de Internet para concluir a instalação.
4. Teste sua conexão com o servidor de gerenciamento do Edge 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 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, esse comando 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"
   }

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

Use o procedimento a seguir para instalar o portal usando o script de instalação automatizada. Esse procedimento funciona para servidores com ou sem uma conexão de Internet externa.

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. Em um servidor com conexão de Internet:
   1. Acesse o novo diretório portal e faça o download do arquivo DeveloperServices_x.y.z.tar dos serviços do canal do desenvolvedor, em que x.y.z corresponde ao número da versão do portal.
      
      É possível fazer o download de um arquivo no link enviado pela Apigee em um navegador ou copiando-o e adicionando-o ao seguinte comando cURL:
      > curl -kOL <paste link here>
   2. Extraia o conteúdo do arquivo .tar do Developer Channel Services usando o comando:
      > tar -xvf <tar file>
   3. CD para DeveloperServices-4.x.y.z.
   4. Execute o script de instalação usando o seguinte comando:
      > ./networked-install.sh
4. Em um servidor sem conexão de Internet:
   1. Copie o arquivo .tar.gz que você criou acima na seção 2. Verifique se o sistema atende aos requisitos do sistema.
   2. Extraia o conteúdo do arquivo .tar.gz usando o comando:
      > tar -xvf <tar file>
   3. Use o comando cd para acessar o diretório criado pelo comando tar.
   4. Defina as permissões no script install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
   5. Execute o script install-from-rpm-bundle.sh usando o comando:
      > ./install-from-rpm-bundle.sh
5. Responda às solicitações.
6. Após a conclusão da instalação, acesse o URL do servidor em um navegador, como:
   http://localhost. 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 do perfil da Apigee.
   
   Observação: normalmente, você já terá configurado um nome de host e o registrado no servidor DNS para não precisar usar http://localhost.
7. Configure a conexão com o MySQL. Se o MySQL estiver em uma máquina remota, expanda a seção Opções avançadas e insira as informações de conexão dessa máquina. Em seguida, selecione Salvar e continuar.
8. Configure a conexão com o endpoint da Apigee inserindo as seguintes informações e, em seguida, 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 do portal do desenvolvedor
   2. URL do endpoint do portal do desenvolvedor
   3. Usuário autenticado do endpoint
   4. Senha dos usuários autenticados
9. Quando solicitado, selecione o botão Instalar amostra de WADL do SmartDocs para instalar a amostra de WADL do SmartDocs. Se você pular essa etapa, o exemplo de API do SmartDocs não vai aparecer no portal.
   Observação: se o portal se conectar a uma instalação do Apigee Edge para nuvem privada e essa instalação do Edge não tiver conexão de Internet externa, será necessário realizar outras configurações do módulo do SmartDocs antes de usá-lo. Para mais informações sobre o SmartDocs, consulte http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
10. Defina as Configurações do servidor SMTP. A Apigee exige que você configure um servidor SMTP para enviar mensagens de e-mail do portal.
    Para mais informações, consulte http://apigee.com/docs/developer-services/content/configuring-email.
11. Configure o usuário administrador inserindo as seguintes informações 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. Criar um usuário administrador.
    1. Nome e sobrenome do desenvolvedor
    2. Nome de usuário do portal do desenvolvedor
    3. Senha
    4. Endereço de e-mail
12. Depois que a instalação for concluída, defina as permissões no arquivo settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
13. Acesse a página inicial do portal em http://localhost/ ou o nome DNS do portal.
14. Faça login no portal usando as credenciais de administrador.

4. Criar um usuário administrador

Use o Drush para criar um usuário administrativo para a instalação do Developer Channel Services. O Drupal cria automaticamente um usuário administrador chamado "admin" por padrão. Portanto, não use "admin" como 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 particulares do Drupal:
   > drush vget file_private_path
   
   Esse comando retorna o caminho para os arquivos particulares do Drupal, por exemplo:
   file_private_path: 'sites/default/private'
   
   Correspondente a /var/www/html/sites/default/private/. Use o seguinte comando para garantir que esse diretório seja gravável pelo proprietário e pelo grupo:
   chmod -R g+w dirPathAndName
   chmod -R o+r dirPathAndName
3. Digite os comandos a seguir 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. Defina a senha raiz do MySQL

Se você instalou o MySQL como parte da instalação do portal, o script de instalação deixa a senha raiz do MySQL definida como o valor padrão, que é 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

Também é necessário atualizar a senha no arquivo /var/www/html/sites/default/settings.php.

6. 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 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 ativada, ative-a.

Depois de ativada, você pode ver as atualizações disponíveis usando o item de menu Relatórios > Atualizações disponíveis. Também é possível usar o seguinte comando do 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 houver atualizações disponíveis e definir a frequência de verificação de atualizações.

7. Opcional: implantação em um servidor de produção

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 sua 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 o usuário anônimo criado por padrão. É altamente recomendável executar esse script para servidores de produção.
2. Se exigido pelas políticas corporativas, ative e configure o SELinux.

8. Opcional: configurar o mecanismo de pesquisa Apache Solr

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 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 do Drupal Solr:

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

9. Opcional: instale o mod_ssl para oferecer suporte a HTTPS

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 o 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. Opcional: instalar o SmartDocs

Com o SmartDocs, é possível documentar suas APIs no portal de serviços para desenvolvedores de modo que a documentação da API seja 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 uma instalação do Edge para 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.

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

11. E agora?

As próximas etapas após a instalação do portal de serviços para desenvolvedores são configurar e personalizar o portal 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ê realiza após a instalação e inclui links para a documentação da Apigee, onde é possível encontrar mais informações: