Como trabalhar com o Acquia

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

A Apigee usa o Acquia, um serviço de gerenciamento de sites, para hospedar versões baseadas na nuvem do portal de serviços para desenvolvedores. O Acquia foi desenvolvido para funcionar com o Drupal. Assim, você pode desenvolver, testar e publicar seu portal em um ambiente seguro.

As seções a seguir descrevem como usar o Acquia para desenvolver e gerenciar seu portal.

Como acessar a interface do Acquia Cloud

Depois de configurar a conta do Acquia Cloud, acesse o portal pela interface do Acquia Cloud em https://cloud.acquia.com/.

Quando você faz login pela primeira vez, a página Aplicativos é exibida, conforme mostrado na figura a seguir.

A página "Aplicativos" mostra todos os aplicativos a que você tem acesso hospedados no Acquia Cloud. Um aplicativo é a entidade de software que você gerencia no Acquia Cloud, como o site do portal baseado no Drupal.

As seções a seguir descrevem como usar a interface do Acquia Cloud para gerenciar o conteúdo do portal.

Para mais informações sobre a interface do Acquia Cloud, consulte Como fazer login na interface do Acquia Cloud e Como gerenciar aplicativos com o Acquia Cloud na documentação do Acquia Cloud.

Como gerenciar seus ambientes

Acesse a interface do Acquia Cloud e, na página "Aplicativos", clique em Gerenciar associado ao site do portal para acessar o painel.

Para gerenciar seu fluxo de trabalho, três ambientes são fornecidos para desenvolver, testar e publicar seu portal, conforme descrito na tabela a seguir. O portal é implantado em cada ambiente, mas pode estar em um estado diferente com uma tag ou ramificação de código exclusiva, um banco de dados e assim por diante. Consulte Como implantar código nos seus ambientes de portal.

Ambiente Descrição URL padrão
Dev Desenvolva novos recursos e personalize seu portal. http://{application-name}xxxxxx.devcloud.acquia-sites.com/

Em que application-name é o nome do aplicativo e xxxxxx é uma string exclusiva de caracteres usada para diferenciar Dev e Stage.

Etapa Teste o código mais recente antes de enviá-lo para o ambiente de produção. http://{application-name}yyyyyy.devcloud.acquia-sites.com/

Em que application-name é o nome do aplicativo e yyyyyy é uma string exclusiva de caracteres usada para diferenciar Dev e Stage.

Prod. Publique seu portal para produção (ativo). http://{application-name}.devcloud.acquia-sites.com/

Em que application-name é o nome do aplicativo.

Observação: consulte também Como configurar um domínio personalizado.

Para mais informações, consulte Como trabalhar com ambientes na documentação do Acquia Cloud.

Como desenvolver seu portal

Confira nas seções a seguir como desenvolver seu portal.

Além disso, consulte as seções a seguir para saber mais detalhes sobre como personalizar seu portal.

Se você quiser...

Você pode

Mais informações

Mudar a aparência do site

Basic: use a entrada de menu Appearance no portal para fazer mudanças, como modificar o logotipo e as cores.

Consulte Personalizar a aparência.

Avançado: para fazer modificações na aparência completa do site, estenda o tema responsivo da Apigee.

Consulte Personalizar o tema.

Alterar o comportamento da funcionalidade do site

Básico: use as configurações de administrador no portal para alterar/definir o comportamento do site.

Consulte a documentação da Apigee aqui.

Avançado: crie um módulo personalizado para alterar qualquer comportamento do site.

Consulte Como criar módulos personalizados na documentação do Drupal.

Visão geral do repositório Git

O repositório Git para o código do Drupal contém todo o código do portal e é organizado usando a estrutura a seguir.

Observação: modifique somente o conteúdo no diretório /sites/all. Se você modificar um conteúdo que está fora do diretório /sites/all, terá problemas ao fazer upgrade para novas versões e poderá enfrentar conflitos de mesclagem ao verificar as mudanças no Git.

Pasta no repositório Git

Descrição

/profiles/apigee

A Apigee manteve módulos e temas, incluindo:

  • /profiles/apigee/modules/contrib: módulos de contribuição do Drupal mantidos pela Apigee
  • /profiles/apigee/themes/contrib: temas de contribuição do Drupal mantidos pela Apigee
  • /profiles/apigee/modules/custom: módulos personalizados criados pela Apigee
  • /profiles/apigee/themes/custom: temas personalizados criados pela Apigee

Observação: não modifique o conteúdo no diretório /profiles/apigee ou você terá problemas ao fazer upgrade para novas versões e poderá enfrentar conflitos de mesclagem ao verificar as mudanças no Git. Para conferir as práticas recomendadas do Drupal, consulte Nunca invada o Core.

/sites/all

Seus módulos e temas personalizados do Drupal. Para saber mais sobre como gerenciar o conteúdo nessa pasta, consulte Adicionar módulos e temas personalizados e Como substituir módulos e temas de perfil do Drupal.

Observação: modifique somente o conteúdo no diretório /sites/all.

Como acessar seu código

Para acessar seu repositório de código no Git, você precisa executar as tarefas descritas nas seções a seguir:

Consulte também Como acessar o código-fonte do portal do desenvolvedor Drupal 7?

Como ativar o acesso SSH ao seu servidor

Antes de usar o Git para gerenciar o código do Drupal, ative o SSH para acessar o servidor. Para mais informações, consulte Como ativar o acesso SSH na documentação do Acquia Cloud.

Para ativar o acesso SSH:

  1. Faça login na interface de contas do Acquia em https://accounts.acquia.com.
  2. Clique em Credentials.
  3. Se solicitado, insira a senha novamente para confirmar sua identidade.
  4. Em "Chaves SSH", clique em Adicionar chave SSH.
  5. Digite as seguintes informações:
    Campo Descrição
    Apelido Apelido para a chave SSH. O apelido pode conter caracteres alfanuméricos e sublinhados.
    Chave pública Chave pública.

    Para informações sobre como gerar uma chave pública SSH, consulte Como gerar uma chave pública SSH na documentação do Acquia Cloud.

  6. Clique em Adicionar chave.

Como acessar seu repositório de código no Git

O repositório Git contém todo o código do site do portal. É possível adicionar um novo código ou personalizar o atual para configurar seu portal. Para mais informações, consulte Como usar o repositório de código na documentação do Acquia Cloud.

Para acessar seu repositório de código no repositório do Git:

  1. Faça login na interface do Acquia Cloud em https://cloud.acquia.com/.
  2. Na página "Aplicativos", clique em Gerenciar para ver os detalhes do portal.
  3. Clique em Informações do aplicativo na barra de navegação.

  4. Copie o comando clone na caixa de diálogo "Informações do aplicativo".
  5. Clone o repositório Git no ambiente local executando um dos seguintes comandos Git:

    Para clonar o repositório do Git e criar uma nova ramificação:

    > git clone --branch [branch] myportal@abcdef.devcloud.hosting.acquia.com:myportal.git [destination]

    Para clonar o repositório Git da ramificação master:

    > git clone myportal@abcdef.devcloud.hosting.acquia.com:myportal.git [destination]

  6. Repita essas etapas quando estiver tudo pronto para preparar, confirmar e enviar por push as alterações ao repositório Git usando os comandos relevantes mostrados na janela Application.

    Quando você confirma uma ramificação no repositório, o Acquia Cloud atualiza o ambiente que executa essa ramificação de código. É possível implantar código nos ambientes do portal, conforme descrito na próxima seção.

Como implantar código nos seus ambientes de portal

Para implantar, alternar ou reverter códigos em um ambiente de portal, mover seu código entre ambientes ou saber mais sobre a estrutura do repositório e o fluxo de trabalho recomendado, consulte Como trabalhar com sites no Aquia Cloud na documentação do Acquia Cloud. Ao implantar um novo código em um ambiente, execute update.php para fazer as atualizações necessárias no banco de dados.

Adicionar módulos e temas personalizados

É possível expandir a funcionalidade do portal adicionando seus próprios módulos e temas personalizados às pastas listadas na tabela a seguir.

Observação: modifique somente o conteúdo no diretório /sites/all. Se você modificar um conteúdo que está fora do diretório /sites/all, poderá ocorrer conflitos de mesclagem ao verificar as mudanças no Git.

Módulo/tema Pasta no repositório Git Mais informações (documentação do Drupal)
Módulos personalizados sites/all/modules/custom Como criar módulos personalizados
Temas personalizados sites/all/themes Como personalizar o tema
Dupal de temas 7

Depois de adicionar o módulo ou tema personalizado ao ambiente Dev, implante-o em Test para testes e, em seguida, no ambiente Live para produção, conforme descrito em Como implantar código nos ambientes do portal.

Substituir módulos e temas de perfil do Drupal

Os módulos e temas nos diretórios a seguir substituem os módulos e temas de perfil do Drupal mantidos e distribuídos pela Apigee em /profiles/apigee. Consulte a Visão geral do seu repositório Git.

Por exemplo, talvez você queira modificar um módulo na distribuição do Apigee Drupal nos seguintes cenários:

  • você quiser usar uma versão diferente de um determinado módulo.
  • Você quer implementar uma atualização de segurança antes da próxima versão programada da Apigee.
Módulo/tema Pasta no repositório Git Mais informações (documentação do Drupal)
Módulos com contribuições do Drupal sites/all/modules/contrib

Observação: os módulos armazenados em qualquer lugar em /sites/all/modules vão substituir os módulos de distribuição do Apigee Drupal.

Módulos de contribuição

Observação: os módulos de contribuição do Drupal nesse diretório modificam os módulos equivalentes mantidos e distribuídos pela Apigee em /profiles/apigee/modules. Remova todos os módulos duplicados adicionados a esta pasta se quiser usar os módulos de perfil Drupal mantidos pela Apigee.

Temas de contribuições do Drupal sites/all/themes Temas de contribuições

Observação: os temas contribuídos com o Drupal nesse diretório modificam módulos equivalentes mantidos e distribuídos pela Apigee em /profiles/apigee/themes. Remova todos os módulos duplicados que você adicionou a esta pasta se quiser usar os temas de perfil mantidos pela Apigee.

Como ativar SSL

Para ativar o acesso seguro ao site usando HTTPS, é necessário ativar o SSL.

Para ativar o SSL:

  1. Consiga um certificado SSL de uma autoridade certificadora (CA, na sigla em inglês) ou de um fornecedor de certificados SSL. Consulte Como ativar a SSL.
  2. Faça upload do certificado SSL na página de SSL da interface do Acquia Cloud. Consulte Como gerenciar certificados SSL.

Como proteger o ambiente de produção

Ao criar um aplicativo pela primeira vez, é possível gerenciar livremente o ambiente de produção e propagar mudanças dos ambientes de desenvolvimento e preparo. Depois de publicar seu conteúdo, convém bloquear o ambiente de produção para evitar atualizações não autorizadas ou acidentais do conteúdo. Para mais informações, consulte Como usar o modo de produção para proteger seu aplicativo ativo na documentação do Acquia Cloud.

Para proteger o ambiente de produção:

  1. Faça login na interface do Acquia Cloud em https://cloud.acquia.com/.
  2. Na página "Aplicativos", clique em Gerenciar para ver os detalhes do site do portal.
  3. Clique em Prod para visualizar os detalhes do ambiente de produção.
  4. Clique em Modo de produção na barra de navegação.
  5. Clique em Ativar para ativar o modo de produção.

Como aplicar atualizações de módulo e tema ao portal

Periodicamente, a Apigee atualiza os módulos e temas no seu portal para a versão mais recente automaticamente. As atualizações são feitas apenas para o ambiente Dev e são marcadas para indicar que precisam ser migradas para outros ambientes do portal.

Se o site não fizer parte da organização de faturamento da Apigee Acquia (um novo site migrado de outro provedor de hospedagem para sua própria organização, por exemplo), será preciso permitir que a Apigee acesse seu repositório Git para receber push de atualização Devportal. Entre em contato com o suporte da Apigee para mais informações.

Se você adicionou módulos ou temas personalizados, precisará atualizá-los manualmente.

A tabela a seguir resume as etapas necessárias para aplicar atualizações de módulo e tema ao portal.

Módulos/temas Descrição
Módulos do Apigee Edge

A Apigee aplica as atualizações automaticamente apenas ao ambiente Dev.

Depois de testar as atualizações, migre-as de Dev para Stage para ambientes Prod, conforme descrito em Como implantar código nos seus ambientes de portal.

Tema responsivo da Apigee

A Apigee aplica atualizações automaticamente apenas ao ambiente Dev.

Depois de testar as atualizações, migre-as de Dev para Stage para ambientes Prod, conforme descrito em Como implantar código nos seus ambientes de portal.

Núcleo Drupal e módulos relacionados

A Apigee aplica atualizações automaticamente apenas ao ambiente Dev.

Depois de testar as atualizações, migre-as de Dev para Stage para ambientes Prod, conforme descrito em Como implantar código nos seus ambientes de portal.

Módulos e temas personalizados

Se você tiver adicionado módulos e temas personalizados ao seu portal, conforme descrito em Como adicionar módulos e temas personalizados, será necessário instalar as atualizações manualmente.

Faça o download manual da versão mais recente para o diretório local ou usando o Drush. Em seguida, prepare, confirme e envie as atualizações por push ao repositório Git. Depois de testar as atualizações, migre-as de Dev para Stage para ambientes Prod, conforme descrito em Como implantar código nos seus ambientes de portal.

Como migrar recursos personalizados

Se você adicionar configurações ou código personalizado ao portal, será necessário mantê-los e migrá-los de ambientes Dev para Stage para Prod.

Para o código no repositório Git, use o processo descrito em Como implantar código nos seus ambientes do portal para migrar o código de Dev para Stage para Prod.

Se você criou configurações personalizadas, use um dos seguintes métodos para migrá-las:

Método Descrição
Exportar a configuração para o código Muitas configurações comuns são "exportáveis" para o código usando o módulo de recursos. Por exemplo, visualizações, painéis, cache de imagens e assim por diante.
Implementar a função hook_update_N() O Drupal gerencia as mudanças do banco de dados e da configuração usando a função hook_update_N().

Se você tem um módulo personalizado, é possível:

  • Adicione funções hook_update_N() ao arquivo .install do módulo para processar as mudanças.
  • Implante essas alterações com o código.
  • Execute update.php para migrar as alterações nos ambientes Stage e Prod.

Como configurar um domínio personalizado

Conforme observado em Como gerenciar seus ambientes, os nomes de domínio padrão para os ambientes do portal terminam em acquia-sites.com. Recomendamos que você forneça um nome de domínio personalizado que personalize e transmita melhor a finalidade do seu site. Por exemplo, uma alternativa popular é:

https://developers.mycompany.com

Para configurar um domínio personalizado:

  1. Adicione seu domínio ao ambiente do site do portal. Consulte Como gerenciar domínios na documentação do Acquia Cloud.
  2. Configure o domínio personalizado com o provedor de DNS. Para isso, aponte a entrada do registro DNS do nome de domínio para o endereço IP público, e não para um domínio acquia-sites.com. Consulte Como apontar registros DNS para seus endereços IP públicos na documentação do Acquia Cloud.

    Observação: não defina a entrada CNAME do nome de domínio como um domínio acquia-sites.com. Isso pode causar problemas de latência ou inatividade no site do portal.

Como monitorar seu portal usando o Acquia Insight

O Acquia Insight é um conjunto de ferramentas que permite otimizar o site do portal monitorando o desempenho, a segurança e a otimização de mecanismos de pesquisa. Para saber mais, acesse Acquia Insight.

Fazendo backup do portal

As tabelas a seguir resumem as opções disponíveis para fazer backup dos componentes do portal.

Componente Detalhes do backup Mais informações nos Documentos do Acquia Cloud
Código
  • O código é mantido por um sistema de controle de versões e marcado sempre que você faz a confirmação.
  • Sincronize ou reverta para uma tag específica a qualquer momento.
Banco de dados
  • Os backups diários são realizados e mantidos por três dias.
  • Programar backups automáticos e sob demanda.
  • Os snapshots de desastres internos de todos os dados são feitos a cada hora.
Arquivos Faça backups manuais ou programe um cron job.
Inscrição completa Faça backup manual usando o Drush.
.
Sistema de arquivos Drupal Use uma das seguintes opções para fazer backups manuais:
  • Copie os arquivos usando um cliente FTP ou ferramentas de linha de comando (rsync e scp).
  • Crie um arquivo compactado usando o Drush.

Observação: o módulo Backup e migração não é compatível com o Acquia Cloud. Para saber mais, consulte O módulo "Backup e migração" não é compatível com o Acquia Cloud.

Como visualizar notificações de atividade

É possível ver notificações de atividade para acompanhar as ações significativas que ocorrem no seu site do portal, como a instalação ou cópia de código entre ambientes, atualizações e backups de bancos de dados, alterações de servidores e muito mais. Para mais informações, consulte Como visualizar notificações de atividade na documentação do Acquia Cloud.

Para ver a lista de notificações:

  1. Faça login na interface do Acquia Cloud em https://cloud.acquia.com/.
  2. Na página "Aplicativos", clique em Gerenciar para ver os detalhes do site do portal.
  3. Clique no ícone de sino no canto superior direito da barra de navegação para ver as notificações mais recentes.

  4. Clique na seta ao lado de uma notificação para ver mais informações sobre a atividade.

Como se inscrever para receber atualizações de status

Inscreva-se para receber atualizações de versão e status da Apigee em status.apigee.com. Clique em Inscrever-se para atualizações, digite seus dados de contato, como endereço de e-mail, quando solicitado, e clique em Assinar. Na página de gerenciamento de notificações por e-mail, verifique se Developer Portal está selecionado, alterne outras configurações de notificação conforme necessário e clique em Update Preferences.

Inscreva-se para receber atualizações de status do Acquia e receber notificações sobre quaisquer interrupções de serviço, manutenção de emergência ou atualizações de segurança feitas na plataforma. Para receber as atualizações do Acquia Cloud:

  1. Navegue até a página Status da Acquia.
  2. Clique em Inscrever-se para receber atualizações.
  3. Selecione o método que você quer usar para receber atualizações (e-mail, SMS etc.).
  4. Na página "Notificações", selecione os produtos de que você quer receber atualizações de status. Por exemplo, Acquia Cloud Enterprise.
  5. Clique em Atualizar preferências.