Como migrar propriedades da interface clássica para a nova interface do Edge

No Apigee Edge para nuvem privada 4.54.00, a interface clássica (o componente edge-ui ) foi removida e não está mais disponível. A nova interface do Edge (o componente edge-management-ui) é a única interface do Edge para nuvem privada.

Não é possível usar edge-ui no Edge para nuvem privada 4.54.00. Se você personalizou a interface clássica definindo propriedades em /opt/apigee/customer/application/ui.properties, a nova interface do Edge não lerá esse arquivo. Depois de atualizar para a versão 4.54.00, defina as propriedades equivalentes em /opt/apigee/customer/application/management-ui.properties.

Nesta página, listamos as propriedades da interface clássica documentadas para ui.properties, as propriedades equivalentes para a nova interface do Edge e as propriedades da interface clássica que não são compatíveis com a nova interface do Edge.

A nova interface do Edge usa o mesmo mecanismo de código com configuração (CwC) que outros componentes do Edge. Para mais informações, consulte Como configurar o Edge.

Comparar as configurações da interface clássica e da nova interface do Edge

A nova interface do Edge substitui o componente da interface clássica, o arquivo de propriedades, o nome do serviço, a porta padrão e o formato do certificado TLS. Consulte a tabela a seguir para atualizar seus scripts de automação, regras de firewall e arquivos TLS antes de migrar suas propriedades:

Definir propriedades para a nova interface do Edge

Defina as propriedades de configuração da nova interface do Edge em /opt/apigee/customer/application/management-ui.properties e reinicie o serviço edge-management-ui para que as mudanças tenham efeito.

Para definir uma propriedade na nova interface do Edge:

1. Abra o arquivo management-ui.properties em um editor. Se o arquivo não existir, crie-o:

   vi /opt/apigee/customer/application/management-ui.properties
   

2. Defina a propriedade. Exemplo:

   conf_uebe_disableGeoMap=true

3. Salve as alterações.
4. Verifique se o arquivo pertence ao usuário apigee:

   chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
   

5. Reinicie a interface do usuário do New Edge:

   /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
   

Siga estas regras de formatação ao definir propriedades para a interface do usuário do New Edge:

• Os nomes de propriedades diferenciam maiúsculas de minúsculas. Por exemplo, conf_uebe_disableGeoMap é válido, mas conf_uebe_disablegeomap não é.
• Coloque os valores de string entre aspas duplas, por exemplo, conf_uebe_branding_companyNameShort="My Company".
• Não coloque valores booleanos (true ou false) ou numéricos entre aspas. Se um valor booleano ou numérico estiver entre aspas, a nova interface do Edge não será iniciada.

Para verificar o valor atual de uma propriedade, use a opção -search. Exemplo:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Mapear propriedades da interface clássica para a nova interface do Edge

As tabelas a seguir mapeiam cada propriedade compatível da interface clássica em ui.properties para a propriedade equivalente da nova interface do Edge em management-ui.properties. A coluna Padrão mostra o valor padrão na nova interface do Edge.

Configurar propriedades de recursos

Associe as flags de recurso da interface clássica às propriedades conf_uebe_* correspondentes em management-ui.properties:

Configurar propriedades de sessão e TLS

Mapeie o tempo limite da sessão da interface clássica e as propriedades de TLS para os equivalentes da nova interface do Edge em management-ui.properties:

Configurar propriedades e modelos de e-mail

Mapeie o remetente, o assunto, a marca, o URL do host e as propriedades de expiração do link do e-mail da interface clássica para a nova interface do Edge:

A nova interface do Edge usa modelos de e-mail integrados. Para usar os modelos que você personalizou para a interface clássica:

1. Crie o diretório /opt/apigee/edge-management-ui/email-templates.
2. Copie os arquivos personalizados password-reset.html, user-added-existing.html e user-added-new.html do diretório de backup que você criou antes da atualização (por exemplo, /opt/apigee/customer/backup/) para /opt/apigee/edge-management-ui/email-templates. Os nomes de arquivo e marcadores de posição do modelo são os mesmos da interface clássica.
3. Verifique se o diretório e os arquivos pertencem ao usuário apigee.
4. Reinicie a interface do usuário do New Edge.

Para mais informações, consulte Como personalizar modelos de e-mail da Edge.

Configurar propriedades de senha geradas automaticamente

Mapeie as propriedades de senha geradas automaticamente da interface clássica para a nova interface do Edge:

Configurar a conexão do servidor de gerenciamento e as propriedades de secret compartilhado

Mapeie as propriedades de conexão, credencial e secret do aplicativo do servidor de gerenciamento da interface clássica para a nova interface do Edge:

Remover propriedades da interface clássica que não exigem ação

As seguintes propriedades da interface clássica não têm equivalente na nova interface do Edge porque o comportamento está sempre ativado. Não inclua essas propriedades em management-ui.properties (e remova-as de todos os scripts de configuração automatizados):

Remover propriedades da interface clássica sem suporte

As seguintes propriedades da interface clássica não são compatíveis e não têm equivalentes na nova interface do Edge. Não inclua essas propriedades em management-ui.properties e remova-as de todos os scripts de configuração automatizados:

Analisar um exemplo de migração

O exemplo a seguir compara um arquivo ui.properties da interface clássica com o arquivo management-ui.properties equivalente para a nova interface do Edge.

Interface clássica, /opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Nova interface do Edge, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

O valor booleano true não está entre aspas, e o tempo limite da sessão 1d é substituído por 24.

Depois de salvar o arquivo, reinicie a nova interface do Edge:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Lista de verificação resumida

Use a checklist a seguir para concluir a migração para a nova interface do Edge no Apigee Edge para nuvem privada 4.54.00:

1. Faça backup de /opt/apigee/customer/application/ui.properties e de todos os modelos de e-mail personalizados de /opt/apigee/edge-ui/email-templates antes de fazer o upgrade.
2. Adicione propriedades mapeadas a /opt/apigee/customer/application/management-ui.properties sem colocar valores booleanos ou numéricos entre aspas e omita propriedades não compatíveis da interface clássica.
3. Copie os modelos de e-mail personalizados do diretório de backup para /opt/apigee/edge-management-ui/email-templates.
4. Criptografe novamente as credenciais de administrador do sistema com ./bin/management-ui --encrypt se você definir conf_uebe_mgmtCredential.
5. Defina a propriedade do arquivo como apigee:apigee e reinicie edge-management-ui.