Instalar o portal

Edge para nuvem privada v4.19.01

Antes de instalar o portal Apigee Developer Services (ou simplesmente o portal), verifique se:

1. 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.
2. 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.
3. O Yum está instalado.

O instalador inclui apenas módulos fornecidos pelo Drupal que são exigidos pelo o portal Apigee Developer Services (ou simplesmente o portal). Para informações sobre como instalar outros módulos de contribuição, consulte Extensão do Drupal 7.

Visão geral da instalação

Para instalar o portal, siga estas etapas. Cada uma dessas etapas é descrita em mais detalhes nas seções a seguir.

1. Testar sua conexão
2. Remover versões do PHP anteriores à 7.0
3. Instalar o Postgres
4. Instalar o portal
5. Verificar se o gerenciador de atualizações está ativado
6. (Opcional) Configurar o Apache Solr
7. (Opcional) Instalar o SmartDocs
8. (Opcional) Configurar o JQuery

Descontinuação da propriedade SMTPSSL

Nas versões anteriores, você usou 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: "padrão", "ssl" ou "tls".

Criar um arquivo de configuração do portal

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 e inclua .

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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

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

1. Testar sua conexão com o Apigee Edge

Teste a conexão entre o servidor no qual você vai instalar o portal e a borda de gerenciamento usando o seguinte comando curl 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 da 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, curl 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

Se você não tiver certeza se o PHP está instalado no servidor, use o seguinte comando:

rpm -qa | grep -i php

O portal usa a versão PHP 4.18.01-0.0.49. Isso não tem o objetivo de corresponder número da versão do Apigee Edge para nuvem privada.

3. Instalar o Postgres

Para instalar o portal, é necessário ter o Postgres instalado. É possível: 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 ele 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 os componentes do Edge em um nó.

Para instalar o Postgres separadamente:

1. Instale o utilitário Edge apigee-setup no nó usando a procedimento na Internet ou fora dela. Consulte Instale o utilitário de configuração da Apigee Apigee para mais informações.
2. Crie um arquivo de configuração do Postgres, conforme o exemplo a seguir:

   # 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 postgres_config_file

   A opção -p pdb especifica a instalação do Postgre. O arquivo de configuração precisa ser acessíveis ou legíveis para o ambiente usuário.

4. Instalar o portal

Antes de instalar o portal, verifique se você fez o seguinte, conforme descrito em 3: Instale o Postgres:

1. Instalar o utilitário Edge apigee-setup no nó do portal
2. Instale o Postgres, seja independente ou como parte da instalação do Edge.

Para instalar o portal, siga estas etapas:

1. No prompt de comando, execute o script setup:

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   Em que:

   • configFile é o arquivo de configuração do portal, conforme descrito em Criar um arquivo de configuração do portal.
   • -p dp instrui o script setup a instalar o portal.

Para verificar se a instalação do portal foi concluída:

1. Navegue para a página inicial do portal em http://localhost:8079 ou até o nome do DNS do seu portal.
2. Faça login no portal usando as credenciais de administrador que você definiu. de configuração do Terraform.
3. Selecione Relatórios > "Status Report" no menu Drupal para garantir que você podem ver o status atual do portal.
4. Verifique se a conexão com o servidor de gerenciamento foi bem-sucedida. Se não foi:
   1. Navegue até a página "Configuração da conexão" do portal (por exemplo, http://portal_IP:8079/admin/config/devconnect).
   2. Clique no botão Testar conexão. Se a conexão for bem-sucedida, e pronto. Se a conexão falhar, continue.
   3. Verifique as configurações do endpoint e da autenticação:
      • URL do endpoint da API de gerenciamento: verifique se o protocolo (HTTP ou HTTPS), o nome do IP ou DNS e o número da porta estão corretos. Por exemplo:

        http://10.10.10.10:8080/v1

      • Usuário autenticado de endpoint:o papel do administrador da organização nome de usuário
      • Senha do usuário autenticado: a senha do administrador da organização senha.

      Os valores padrão refletem as definições no arquivo de configuração do portal que você criado durante o processo de instalação.

      Esses valores devem corresponder a ms_IP_or_DNS, email e password valores usados na etapa 1: Teste sua conexão com o Apigee Edge. O nome de usuário e a senha também precisam corresponder aos valores de USER_NAME. e USER_PWD na arquivo de configuração de integração ou o credenciais de qualquer usuário com papel de Administrador da organização.

   4. Depois de estabelecer a conexão com o servidor de gerenciamento, clique no botão Salvar configuração na parte inferior da página para salvar as alterações.

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

Você precisa executar esse comando no diretório raiz do site. Por padrão, o o portal está instalado em /opt/apigee/apigee-drupal/wwwroot. Portanto, mude o diretório para /opt/apigee/apigee-drupal/wwwroot antes ao 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 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.

7. Instalar o SmartDocs (opcional)

O SmartDocs permite documentar suas APIs no portal de maneira que o 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 saber mais sobre a instalação do Edge e do SmartDocs, consulte Instale o SmartDocs.

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

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 para uma instalação que não seja de Internet, ele tentará acessar a CDN e causará atrasos na página carregando. 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:

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

9. Próximas etapas

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: