Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
A Apigee usa o Pantheon, um serviço de gerenciamento de sites, para hospedar versões baseadas na nuvem do portal de serviços para desenvolvedores. O Pantheon foi desenvolvido para funcionar com o Drupal para permitir que você desenvolva, teste e publique seu portal em um ambiente seguro. O serviço de gerenciamento de sites da Pantheon está disponível para clientes com necessidades de operação de hospedagem e desenvolvimento em todo o mundo.
As seções a seguir descrevem como usar o Pantheon para desenvolver e gerenciar seu portal.
Como acessar o painel do Pantheon
Quando a Apigee envia o URL do seu portal, você também recebe o URL do painel do Pantheon: https://dashboard.getpantheon.com/.
Ao fazer login pela primeira vez no painel do Pantheon, você será direcionado à página Sites, mostrada abaixo:
Nele, é possível acessar o site, configurar sua conta e realizar outras operações.
Selecione a imagem do seu site (por exemplo, apigeedocs) para abrir o painel dele:
Como gerenciar seus ambientes
No painel do Pantheon, há três ambientes listados na parte superior da página: Dev, Test e Live. Cada um é descrito na tabela a seguir.
|
Ambiente |
Descrição |
|---|---|
|
Desenvolvedor |
O ambiente Dev está conectado ao seu repositório Git. Todas as alterações enviadas ao Git aparecem imediatamente no ambiente Dev. O URL do site está no formato abaixo, em que org_name é o nome da sua organização: http://dev-{org_name}.devportal.apigee.io/ |
|
Teste |
O ambiente de Teste serve para testar seu código mais recente com uma cópia dos dados do ambiente Ativo. É nesse ambiente que você testa as alterações de código antes de enviá-las ao ambiente Ativo. O URL do site está no formato abaixo, em que org_name é o nome da sua organização: http://test-{org_name}.devportal.apigee.io/ |
|
Live |
O ambiente ativo é o ambiente de produção que você torna acessível aos seus clientes. O URL do site está no formato abaixo, em que org_name é o nome da sua organização: http://live-{org_name}.devportal.apigee.io/ |
Como desenvolver o conteúdo do portal
As seções a seguir descrevem como desenvolver o conteúdo do portal.
- Visão geral do repositório Git
- Como acessar seu código
- Como implantar código nos seus ambientes de portal
- Como adicionar módulos e temas personalizados
- Substituição de módulos e temas de perfil do Drupal
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:
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 alterações 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 fazendo upload de uma chave SSH no Pantheon.
Para ativar o acesso SSH ao seu servidor:
- Faça login no Pantheon em https://dashboard.getpantheon.com/.
- No painel, selecione Conta.
- Selecione Chaves SSH no menu à esquerda.
- Adicione a chave e selecione Adicionar chave.
Se precisar de ajuda, selecione o link Saiba como gerar uma chave SSH.
Como acessar seu repositório de código no Git
Observação: consulte a Visão geral do repositório Git para saber mais sobre a estrutura do repositório do Git.
Para acessar o repositório de código no Git:
- Faça login no painel do Pantheon.
- Na página principal do Google Sites, selecione o ícone do seu portal.
- O URL do repositório do Git aparece na página à direita de Connection Mode, como mostrado na figura anterior.
- Copie o URL do seu repositório Git e clone-o para o ambiente de desenvolvimento local usando
o comando:
> git clone gitURL sitename
Por exemplo:
> git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repository.git devportal
Todas as alterações de código que você enviar por push para o repositório Git aparecem imediatamente no ambiente Dev do portal.
Como implantar código nos seus ambientes de portal
Para programar nos seus ambientes do portal:
- Enviar as atualizações de código para o Git, que atualiza imediatamente o ambiente Dev.
- Faça login no Pantheon e selecione seu site.
- Selecione o ambiente Dev.
- Selecione </>Code no menu à esquerda para ver uma mensagem sobre a alteração do código no Registro de confirmação:
- Selecione o ambiente de teste na parte de cima da página.
- Se você ainda não fez o upload de Dev para Test, vai receber uma solicitação para fazer isso agora.
- Se você já tiver um ambiente Test, uma mensagem será exibida indicando
que há uma confirmação de Dev pronta para implantar:
- Se você já enviou um site para o ambiente Live, pode marcar a terceira caixa de seleção para copiar o banco de dados ativo e os arquivos enviados por desenvolvedores para Test em Live. Isso é útil se você quiser testar suas alterações de código em relação aos dados mais recentes disponíveis em Live.
- Selecione o botão Implantar código do desenvolvimento.
- Teste o portal no ambiente de Teste.
- Faça todas as correções de código no ambiente Dev e envie os arquivos novamente para Test para teste.
- Quando o teste for concluído, selecione o ambiente Ativo na parte superior da
página.
- Se você ainda não fez o upload de Test para Live, vai precisar fazer isso agora.
- Se você já tiver um ambiente Live, será exibida uma mensagem indicando que há uma confirmação de Test pronta para implantação. Implante essas alterações da mesma maneira que você fez em Test de Dev. Quando terminar de testar, envie o código para o ambiente Live.
Saiba mais:
- O Pantheon fornece um conjunto de artigos ativos sobre este processo para você visualizar. Um dos mais importantes é o artigo Como usar o fluxo de trabalho do Pantheon, que fornece uma visão geral de como desenvolver, testar e enviar seu site.
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 |
Observação: os módulos armazenados em qualquer lugar em |
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 |
| 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 |
Sobre o arquivo settings.php
O settings.php do Drupal está confirmado no repositório Git upstream do Portal do desenvolvedor do Apigee Drupal. Se você quiser fazer mudanças no arquivo sites/default/settings.php, não o edite diretamente.
Em vez disso, crie um arquivo chamado sites/default/settings.local.php e coloque seu código personalizado nele. O sites/default/settings.local.php é incluído pelo arquivo settings.php.
Por exemplo, ao configurar um domínio personalizado para um site ativo seguindo as instruções fornecidas pelo Pantheon, em vez de modificar o arquivo settings.php diretamente, adicione as atualizações necessárias em sites/default/settings.local.php.
Como proteger seu portal
Os sites de portal associados aos ambientes Dev, Test e Live podem ser acessados publicamente por padrão. Isso significa que qualquer pessoa com o URL do site pode acessá-lo, mas talvez não consiga registrar uma conta ou fazer login no site. Para mais informações sobre como controlar o registro de usuários, consulte Adicionar e gerenciar contas de usuário.
É provável que você queira ocultar seu site Dev e Test do público, mas quer ocultar seu site Live até concluir o desenvolvimento. O Pantheon permite adicionar o controle de nome de usuário/senha para bloquear um site, para que apenas pessoas com as credenciais adequadas possam acessá-lo.
Adicione bloqueio a qualquer um dos três ambientes selecionando Segurança no menu à esquerda do ambiente. Para mais informações, consulte Como bloquear seu site.
Se você quiser ativar o TLS/SSL para seu site, consulte Usar TLS no portal.
Como aplicar uma atualização da Apigee ao seu portal
Quando a Apigee publica uma nova versão do portal, uma mensagem é exibida no painel do Pantheon.
Normalmente, você aplica a atualização ao ambiente Dev e testa essas alterações da mesma maneira que testa suas próprias alterações de código. Por exemplo, envie o ambiente Dev para Test, envie os dados ativos de Live para Test e, em seguida, teste a atualização.
Para aplicar uma atualização:
- Faça login no Pantheon em https://dashboard.getpantheon.com/ e selecione seu site.
- Selecione o ambiente Dev.
- Selecione a entrada de menu </>Código à esquerda. Se houver alguma atualização da Apigee disponível, ela será listada.
- Aplique a atualização:
-
Marque a caixa de seleção Executar update.php depois de extrair o código.
-
Se disponível, marque a caixa de seleção Limpar caches após extrair o código.
-
Selecione o botão Implantar código.
-
- Depois que a atualização for concluída, selecione o item de menu Status à esquerda do painel.
- Na área Status de um ambiente, é possível notar um erro na atualização do banco de dados, conforme mostrado abaixo:
Se você encontrar esse erro em qualquer ambiente, atualize manualmente o banco de dados:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione o ícone da página inicial > Executar atualizações no canto superior esquerdo do portal.
- Siga as instruções para atualizar o banco de dados.
- Envie as alterações de código para o ambiente de Teste e, em seguida, as envie para Ativo, conforme descrito acima.
Como migrar recursos personalizados
Se você adicionar código ou recursos personalizados ao portal, precisará decidir como mantê-los e movê-los dos ambientes Dev para Test e Live.
Para o código no repositório do Git, use o processo descrito em Como implantar código nos seus ambientes do portal para migrar o código de Dev para Test e Live.
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:
|
Consulte também Como usar o fluxo de trabalho do Pantheon, que fornece uma visão geral de como desenvolver, testar e enviar seu site. Esse artigo também inclui a seção sobre o Gerenciamento de configuração.
Como configurar um domínio personalizado
Os nomes de domínio que a Apigee fornece para um portal com o padrão apigee.io, conforme
descrito em Como gerenciar seus ambientes, que talvez não seja o que você
quer expor aos clientes.
Os planos pagos podem configurar um nome de domínio personalizado para o portal. O desenvolvedor ou contas sem custo financeiro não podem criar um domínio personalizado. Para usar um domínio personalizado, crie um CNAME no seu DNS e aponte seu domínio para edge.apigee.getpantheon.com.
Por exemplo, para configurar o domínio personalizado para uma empresa chamada Mytech:
- Defina a seguinte configuração de DNS:
developer.mytech.com. 3600 IN CNAME Edge.apigee.getpantheon.com
Pode levar até 48 horas para que essa alteração de DNS entre em vigor em todos os dispositivos clientes. - Use a entrada de menu Domínios / SSL no lado esquerdo do painel para adicionar esse domínio ao painel do Pantheon apenas para o ambiente Ativo.
Na maioria dos casos, você só configura o DNS para o ambiente Live, não para Dev e Test. Não use os ambientes Dev ou Test para produção.
Para mais informações, consulte a documentação do Pantheon aqui.
Como adicionar administradores do portal
Quando você receber o e-mail da Apigee informando que o portal está pronto, a Apigee já terá configurado a lista de administradores do portal. Você pode ver essa lista selecionando o link Equipe no canto superior direito do painel do site.
Para adicionar mais administradores, consulte Criar usuários administradores.
Fazendo backup do portal
Para fazer backup do seu portal, use a guia Backups no painel do Pantheon. É possível criar um backup sob demanda ou automatizado. No Pantheon, um backup consiste em três arquivos separados: banco de dados, arquivos e código.
Para mais informações, consulte Ferramenta de backups na documentação do Pantheon.
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 e relatórios de incidentes do Pantheon, como quando ocorre uma falha temporária, em http://status.getpantheon.com. Clique em Inscrever-se para atualizações.