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 do Developer Channel Services.

Antes de continuar com a instalação, faça um backup de toda a raiz da Web do Drupal diretório. O local de instalação padrão é /var/www/html, mas pode ter sido alterado por você no momento da instalação. Após executar as etapas de instalação descritas abaixo, você pode restaurar os personalizações do backup.

1. Instalar o pacote do Developer Channel Services

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

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

2. Verificar se o sistema atende requisitos

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

  1. Verifique se 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 aqui.
  2. Verifique se o Yum está instalado.
  3. (Para uma instalação em um servidor sem conexão com a Internet) Você precisa primeiro, faça o download de todos os arquivos necessários em um servidor com conexão à Internet como um arquivo .tar.gz. Em seguida, copie o arquivo .tar.gz para o servidor sem conexão com a Internet para executar a instalação.
    1. Faça login em um servidor com conexão à Internet como raiz ou superusuário.
    2. Crie um diretório para os arquivos de instalação, como portal_tar.
    3. use o CD para acessar o novo diretório 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:
      &gt; tar -xvf <tar file&gt;
    5. CD para DeveloperServices-4.x.y.z.
    6. Crie o arquivo .tar.gz do portal usando o comando:
      &gt; ./non-networked-install.sh

      Esse comando baixa todos os arquivos necessários em um único arquivo .tar.gz. Você depois copie o arquivo .tar.gz para seu servidor que não tem conexão com a Internet para concluir instalar.
  4. Execute o comando cURL a seguir para testar sua conexão com o Servidor de gerenciamento de borda. em um prompt de comando no servidor do portal:
    &gt; curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

    Em que E-MAIL e SENHA são o e-mail endereço de e-mail e senha do administrador para NOME DA ORGANIZAÇÃO.

    Não se esqueça de especificar o nome do host e o número da porta específicos para a instalação do Edge. 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, este comando retornará uma resposta semelhante à seguinte:
    {
    "createdAt" : 1348689232699
    "createdBy" : "NOME DE USUÁRIO",
    &quot;displayName&quot; : "cg",
    "ambientes" : [ "teste", "prod" ],
    "lastModifiedAt" : 1348689232699
    "lastModifiedBy" : "foo@bar.com",
    "nome" : "cg",
    "propriedades" : {
    "propriedade" : [ ]
    },
    "tipo" : "teste"
    }

3. Instalar desenvolvedor Channel Services usando o script de instalação automatizado

Siga o procedimento a seguir para instalar o portal usando o script de instalação automatizado. Isso funciona para servidores com ou sem uma conexão externa à Internet.

  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 à Internet:
    1. CD no novo portal e faça o download do Developer Channel Services DeveloperServices_x.y.z.tar em que x.y.z corresponde ao número da versão do portal.

      É possível fazer o download de um arquivo pelo link enviado pela Apigee em um navegador ou copiá-lo e adicionando-a ao seguinte comando cURL:
      &gt; curl -kOL <colar link here&gt;
    2. Extraia o conteúdo do arquivo .tar do Developer Channel Services usando o comando:
      &gt; tar -xvf <tar file&gt;
    3. CD para DeveloperServices-4.x.y.z.
    4. Execute o script de instalação usando o seguinte comando:
      &gt; ./networked-install.sh
  4. Em um servidor sem conexão com a Internet:
    1. Copie o arquivo .tar.gz que você criou acima na seção 2. Verifique se o sistema atende os requisitos do sistema.
    2. Extraia o conteúdo do arquivo .tar.gz usando o comando:
      &gt; tar -xvf <tar file&gt;
    3. CD no diretório criado pelo comando tar.
    4. Defina as permissões no script install-from-rpm-bundle.sh:
      &gt; chmod 755 install-from-rpm-bundle.sh
    5. Execute o script install-from-rpm-bundle.sh ao usando o comando:
      &gt; ./install-from-rpm-bundle.sh
  5. Responda às solicitações.
  6. Após a conclusão da instalação, navegue até o URL do servidor em um navegador, como 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 do perfil da Apigee.

    Observação: normalmente, você já configurou e registrou um nome de host. ao seu servidor DNS para que você não precise usar http://localhost.
  7. Configurar a conexão com o MySQL. Se o MySQL estiver em uma máquina remota, expanda o Opções avançadas e digite as informações de conexão na máquina. e selecione Salvar e continuar.
  8. Configure a conexão com o endpoint da Apigee inserindo as informações a seguir e e selecione Salvar:
    Para mais informações sobre esses valores, consulte "Informações necessárias antes de iniciar a instalação" no portal de serviços para desenvolvedores requisitos.
    1. Organização do Portal do desenvolvedor
    2. URL do endpoint do Portal do desenvolvedor
    3. Usuário autenticado de endpoint
    4. Usuários autenticados Senha
  9. Quando solicitado, selecione o botão Install Sample SmartDocs WADL para instalar a amostra de WADL do SmartDocs. Se você pular esta etapa, o exemplo da API SmartDocs não aparecem no seu portal.
    Observação: se o portal se conectar a uma instalação do Apigee Edge for Private Cloud e a instalação do Edge não tiver conexão externa com a Internet, configuração adicional do módulo SmartDocs antes de usar o SmartDocs. Para mais informações sobre 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 uma Servidor SMTP para enviar mensagens de e-mail pelo portal.
    Para mais informações, consulte http://apigee.com/docs/developer-services/content/configuring-email.
  11. Configure o usuário administrador inserindo as informações a seguir e selecione Salvar. Observe que o Drupal cria um usuário administrador chamado "admin" por padrão, portanto não use "admin" quando o nome de usuário.
    Se pular esta etapa, você 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 do portal do desenvolvedor
    3. Senha
    4. Endereço de e-mail
  12. Após a conclusão da instalação, defina as permissões no arquivo settings.php:
    &gt; chmod 640 /var/www/html/sites/default/settings.php
  13. Navegue até a página inicial do portal em http://localhost/ ou acesse o nome do DNS de seu 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 Channel Services para desenvolvedores. 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 no diretório drupal_root/sites/default. O local padrão da raiz Drupal diretório é /var/www/html:
    &gt; cd &lt;drupal_root&gt;/sites/default
  2. Verifique se você tem permissões de gravação nos arquivos particulares do Drupal:
    &gt; 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 seguinte comando para garantir que este diretório é gravável 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:
    &gt; drush – criar usuário <nome_de_usuário> --mail=&quot;&lt;email-address&gt;&quot; --password=&quot;&lt;password&gt;&quot;
    &gt; 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 deixa a Senha raiz do MySQL definida com o valor padrão, que está 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

Atualize também a senha em /var/www/html/sites/default/settings.php .

6. Verifique se o módulo Gerenciador de atualizações está ativada

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 Drupal, selecione Modules e role para baixo até a Atualizar gerenciador. Se não estiver, ative-a.

Depois de ativados, é possível ver as atualizações disponíveis usando o menu Relatórios > Disponível Atualizações. Também é possível usar o seguinte comando Drush:

> drush pm-info update

Use o menu Relatórios > Atualizações disponíveis > Configurações do item de menu a ser configurado módulo para enviar um e-mail a você quando as atualizações estiverem disponíveis e para definir a frequência de verificação atualizações.

7. Opcional - Como implantar em uma produção servidor

Se você estiver implantando o portal em um servidor de produção, será necessário executar mais medidas de segurança incluindo:

  1. Execute o script a seguir para proteger sua instalação do MySQL:
    &gt; /usr/bin/mysql_secure_installation

    Esse script define a senha raiz e oferece a opção de restringir o acesso raiz apenas localhost e remover os bancos de dados de teste e o usuário anônimo criados por padrão. Ao executar é altamente recomendado para servidores de produção.
  2. Se exigido pelas políticas corporativas, ative e configure o SELinux.

8. Opcional - Configurar o Apache Solr mecanismo de pesquisa

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 busca interno Drupal e, portanto, não exigem os módulos Drupal Solr.

Se você decidir usar o Solr como seu mecanismo de pesquisa, instale o Solr localmente no seu servidor ativar e configurar os módulos Drupal Solr no portal.

Para ativar os módulos Drupal Solr:

  1. Faça login no seu portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Modules no menu Drupal.
  3. Ative o módulo Apache Solr Framework e o 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 HTTPS

O módulo mod_ssl é usado pelo servidor HTTP Apache para exibir páginas da Web por HTTPS. Se você Se 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

O SmartDocs permite documentar suas APIs no portal de serviços para desenvolvedores de maneira a tornar 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 é necessária.
  • Se você estiver conectando o portal a um Edge para instalação de nuvem privada, será preciso que o SmartDocs esteja instalado no Edge. Para mais informações 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 do Google.

11. E agora?

As próximas etapas após a instalação do portal de serviços para desenvolvedores são configurar e personalizar de acordo com suas necessidades específicas. A documentação no site da Apigee contém todos os 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 em que você encontra mais informações:

Tarefa

Descrição

Personalizar o tema

O tema define a aparência do portal, incluindo cores, estilo e outros aspectos visuais.

Personalize 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 novos desenvolvedores registram uma conta no no portal do Google Cloud. Por exemplo, os novos desenvolvedores têm acesso imediato ao portal ou precisam ser verificadas por um administrador. Esse processo também controla como um portal do Google Workspace é 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 um desenvolvedor se registrar no portal e perder a senha.

Adicionar e gerenciar contas de usuário

Adicione termos e Página "Condições" que os desenvolvedores precisam aceitar antes de poderem fazer isso acessar o portal.

Adicionar e gerenciar contas de usuário

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

Adicionar blog e postagens de fórum

O portal tem suporte integrado para blogs e fóruns com conversas agrupadas. Definir as permissões para visualizar, adicionar, editar e excluir postagens de blogs e fóruns.

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

Verifique se você está fazendo backup do banco de dados Drupal. Observe que, como cada é diferente, cabe a você determinar a melhor forma de fazer backup no seu banco de dados.

Configurar um nome do host

Se você não configurar um nome do host em seu servidor DNS, sempre poderá acessar o site via o endereço IP do servidor. Se quiser usar um nome de host, você pode configurar o DNS para servidor, que deve 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 site por alguns outro motivo, você pode definir $base_url no arquivo settings.php do Portal de desenvolvedores que fica localizado por padrão no diretório /var/www/html/sites/default diretório.