Esta página foi traduzida pela API Cloud Translation.

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

Edge for Private Cloud v. 4.17.05

Antes de instalar, verifique se:

Instale o Postgres antes de instalar o portal. É possível instalar o Postgres como parte de instalar o Edge ou instalar o Postgres autônomo para uso no portal.
- Se você instalar o Postgres de forma independente, 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 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 em Software e versões compatíveis.
O Yum está instalado.

Visão geral da instalação

Depois de instalar o Edge com o utilitário apigee-setup em um nó, use este para instalar o portal no nó. O utilitário apigee-setup tem o seguinte 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 contenha as seguintes informações: sobre a instalação. Se o arquivo de configuração estiver sem informações necessárias, o utilitário apigee-setup vai solicitar que você as insira na linha de comando.

A única exigência é que o arquivo de configuração possa ser acessado ou lido por "apigee" usuário.

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 Apigee. para saber mais.

Como criar um arquivo de configuração

Veja abaixo um exemplo de arquivo de configuração silenciosa para uma instalação do portal. Editar este arquivo conforme necessário para sua configuração. Use a opção -f para setup.sh para incluir esse arquivo.

Observação: não defina DEVPORTAL_ADMIN_USERNAME=admin. A conta de usuário admin é criada por padrão. Se especificado, uma mensagem de erro é retornada solicitando que você configure um nome de usuário diferente.

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 

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# 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

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:

> 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 e-mail endereço de e-mail e senha do administrador de ORGNAME.

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" : "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 e instalação. Se houver versões anteriores à 7.0 do PHP, 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 instalar o portal, é necessário ter o Postgres instalado. Você pode: instalar o Postgres como parte da instalação do Edge ou instalar o Postgres autônomo para uso no portal do Google Cloud.

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

Instale o utilitário apigee-setup do Edge no nó usando a procedimento na Internet ou fora dela. Consulte Instalar o utilitário de configuração da Apigee Apigee (em inglês) para mais.
Crie um arquivo de configuração para o Postgres, conforme mostrado abaixo:

# Deve ser resolvido para endereço IP ou DNS do host, e não para 127.0.0.1 ou localhost.
HOSTIP=$(nome do host -i)

# O pod e a região do Postgres. Use os valores padrão mostrados abaixo.
MP_POD=gateway
REGION=dc-1

# Defina a senha do Postgres. O valor padrão é "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 configFile

A opção "-p pdb" especifica a instalação do Postgre.

O arquivo de configuração precisa ser acessível ou legível para a "apigee" usuário.

4. Instalar o portal

Para instalar o portal, siga estas etapas:

Instale o utilitário apigee-setup do Edge na sua conta o nó usando o procedimento de Internet ou não. Consulte Instalar o utilitário de configuração da Apigee Apigee (em inglês) para mais.
Verifique se você instalou o Postgres, independente ou como parte do instalar o Edge.
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 ser acessível ou legível para a "apigee" usuário.
Navegue para a página inicial do portal em http://localhost:8079 ou para o nome do DNS de seu portal.
Faça login no portal usando as credenciais de administrador definidas na configuração. .

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

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 do Drush:

> drush pm-info update

Você precisa executar esse comando no diretório raiz do site. Por padrão, o Desenvolvedor O Portal está instalado em /opt/apigee/apigee-drupal/wwwroot. Portanto, primeiro mude o diretório para /opt/apigee/apigee-drupal/wwwroot antes de executar o comando. Se você não tiver instalado o portal no diretório padrão, mude para seu de instalação do aplicativo.

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.

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

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

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

8. Configure o Módulo de atualização do JQuery para instalações não relacionadas à Internet (opcional)

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

Para configurar o módulo de atualização do JQuery para usar a versão local do JQuery:

Faça login no seu portal como usuário com privilégios de administrador ou de criação de conteúdo.
Selecione Configuração > Desenvolvimento > Atualização do JQuery no menu Drupal.
Clique em Performance na navegação à esquerda.
No menu suspenso "CDN da interface do JQuery e JQuery", selecione Nenhum.
Clique em Save configuration.

9. E agora?

As próximas etapas após instalar o 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, onde você pode 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.
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 verificados 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 baseado em função. Antes de permitir que os desenvolvedores se registrar, definir as permissões e funções usadas pelo portal.
Adicionar postagens de blogs e fóruns	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. Observação: o módulo de backup e migração não é compatível com o Postgres. bancos de dados. Consulte também Como fazer um backup.
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ê configurar um balanceador de carga ou receber URLs incorretos no site por algum outro motivo, defina $base_url no arquivo settings.php do portal para desenvolvedores, que fica no diretório /opt/apigee/apigee-drupal/wwwroot/sites/default por padrão.
Desenvolvimento personalizado	Você também pode ampliar os recursos do seu portal com código personalizado tema. Para fazer isso, crie seu próprio módulo Drupal conforme descrito no módulo desenvolvimento e coloque o módulo no `/sites/all/modules` diretório.