Tarefas de manutenção no AEM as a Cloud Service maintenance-tasks-in-aem-as-a-cloud-service

Tarefas de manutenção são processos executados de acordo com um cronograma para otimizar o repositório. Com o AEM as a Cloud Service, a necessidade de os clientes configurarem as propriedades operacionais das tarefas de manutenção é mínima. Os clientes podem concentrar seus recursos em preocupações no nível do aplicativo, deixando as operações de infraestrutura para a Adobe.

Configurar tarefas de manutenção maintenance-tasks-configuring

Em versões anteriores do AEM, você podia configurar as tarefas de manutenção usando o Cartão de manutenção (Ferramentas > Operações > Manutenção). Para o AEM as a Cloud Service, o Cartão de manutenção não está mais disponível, portanto, as configurações devem ser enviadas ao controle de origem e implantadas usando o Cloud Manager. O Adobe gerencia as tarefas de manutenção que têm configurações não configuráveis pelos clientes (por exemplo, coleta de lixo do armazenamento de dados). Outras tarefas de manutenção podem ser configuradas pelos clientes, conforme descrito na tabela abaixo.

CAUTION
O Adobe reserva o direito de substituir as configurações da tarefa de manutenção de um cliente para atenuar problemas como degradação de desempenho.

A tabela a seguir ilustra as tarefas de manutenção disponíveis.

Tarefa de manutenção
Quem é o proprietário da configuração
Como configurar (opcional)
Coleta de lixo do armazenamento de dados
Adobe
N/A — de propriedade total da Adobe
Remoção da versão
Cliente
A limpeza de versão está desabilitada no momento por padrão, mas a política pode ser configurada, conforme descrito na seção Tarefas de Manutenção de Limpeza de Versão e Limpeza de Log de Auditoria.

A limpeza será em breve habilitada por padrão, com esses valores substituíveis.
Limpeza do log de auditoria
Cliente
A limpeza de log de auditoria está desabilitada por padrão no momento, mas a política pode ser configurada, conforme descrito na seção Tarefas de Manutenção de Limpeza de Versão e Limpeza de Log de Auditoria.

A limpeza será em breve habilitada por padrão, com esses valores substituíveis.
Limpeza de binários do Lucene
Adobe
Não usado e, portanto, desabilitado pela Adobe.
Limpeza de tarefa ad-hoc
Cliente

Deve ser feito no Git. Substitua o nó de configuração da janela de manutenção pronto para uso em /libs criando propriedades na pasta /apps/settings/granite/operations/maintenance/granite_weekly, granite_daily ou granite_monthly.

Consulte a tabela Janela de manutenção abaixo para obter mais detalhes sobre a configuração. Ative a tarefa de manutenção adicionando outro nó sob o nó acima. Nomeie-o granite_TaskPurgeTask, com o atributo sling:resourceType definido como granite/operations/components/maintenance/task e o atributo granite.maintenance.name definido como TaskPurge. Para configurar as propriedades OSGI, consulte com.adobe.granite.taskmanagement.impl.purge.TaskPurgeMaintenanceTask para obter a lista de propriedades.

Remoção do fluxo de trabalho
Cliente

Deve ser feito no Git. Substitua o nó de configuração da janela de manutenção pronto para uso em /libs criando propriedades na pasta /apps/settings/granite/operations/maintenance/granite_weekly, granite_daily ou granite_monthly. Consulte a tabela Janela de manutenção abaixo para obter mais detalhes sobre a configuração.

Ative a tarefa de manutenção adicionando outro nó sob o nó acima (nomeie-o como granite_WorkflowPurgeTask) com as propriedades adequadas. Para configurar as propriedades do OSGI, consulte Documentação da tarefa de manutenção do AEM 6.5.

Remoção do projeto
Cliente

Deve ser feito no Git. Substitua o nó de configuração da janela de manutenção pronto para uso em /libs criando propriedades na pasta /apps/settings/granite/operations/maintenance/granite_weekly, granite_daily ou granite_monthly. Consulte a tabela Janela de manutenção abaixo para obter mais detalhes sobre a configuração.

Ative a tarefa de manutenção adicionando outro nó sob o nó acima (nomeie-o como granite_ProjectPurgeTask) com as propriedades apropriadas. Consulte a lista de propriedades OSGI em "Configuração de limpeza de projetos Adobe".

Configuração da janela de manutenção
Quem é o proprietário da configuração
Tipo de configuração
Parâmetros
Diariamente
Cliente
Definição de Nó JCR

windowSchedule=daily (esse valor não deve ser alterado)

windowStartTime=HH:MM usando como relógio de 24 horas. Define quando as tarefas de manutenção associadas à Janela de manutenção diária devem começar a ser executadas.

windowEndTime=HH:MM usando como relógio de 24 horas. Define quando as tarefas de manutenção associadas à Janela de manutenção diária devem parar de ser executadas se ainda não tiverem sido concluídas.

Uma tarefa de manutenção não pode ser executada mais de uma vez durante esse período.

Semanalmente
Cliente
Definição de Nó JCR

windowSchedule=weekly (esse valor não deve ser alterado)

windowStartTime=HH:MM usando como relógio de 24 horas. Define quando as tarefas de manutenção associadas à Janela de manutenção semanal devem começar a ser executadas.

windowEndTime=HH:MM usando como relógio de 24 horas. Define quando as tarefas de manutenção associadas à Janela de manutenção semanal devem parar de ser executadas se ainda não tiverem sido concluídas.

Uma tarefa de manutenção não pode ser executada mais de uma vez durante esse período.

windowScheduleWeekdays= Matriz de dois valores de 1 a 7 (por exemplo, [5,5]) O primeiro valor da matriz é o dia de início em que o trabalho é agendado e o segundo valor é o dia de término em que o trabalho será interrompido. A hora exata de início e término é regida pelos parâmetros windowStartTime e windowEndTime, respectivamente.

Mensalmente
Cliente
Definição de Nó JCR

windowSchedule=month (esse valor não deve ser alterado)

windowStartTime=HH:MM usando como relógio de 24 horas. Define quando as tarefas de manutenção associadas à Janela de manutenção mensal devem começar a ser executadas.

windowEndTime=HH:MM usando como relógio de 24 horas. Define quando as tarefas de manutenção associadas à Janela de manutenção mensal devem parar de ser executadas se ainda não tiverem sido concluídas.

Uma tarefa de manutenção não pode ser executada mais de uma vez durante esse período.

windowScheduleWeekdays=Matriz de dois valores de 1 a 7 (por exemplo, [5,5]) O primeiro valor da matriz é o dia de início em que o trabalho é agendado e o segundo valor é o dia de término em que o trabalho será interrompido. A hora exata de início e término é regida pelos parâmetros windowStartTime e windowEndTime, respectivamente.

windowFirstLastStartDay= 0/1 0 para agendar na primeira semana do mês ou 1 para agendar na última semana do mês. A ausência de um valor agendaria trabalhos no dia regido por windowScheduleWeekdays (todos os meses).

Localizações:

  • Diariamente - /apps/settings/granite/operations/maintenance/granite_daily
  • Semanalmente - /apps/settings/granite/operations/maintenance/granite_weekly
  • Mensalmente - /apps/settings/granite/operations/maintenance/granite_monthly

Exemplos de código:

Exemplo de código 1 (diariamente)

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
  xmlns:jcr="http://www.jcp.org/jcr/1.0"
  jcr:primaryType="sling:Folder"
  sling:configCollectionInherit="true"
  sling:configPropertyInherit="true"
  windowSchedule="daily"
  windowStartTime="03:00"
  windowEndTime="05:00"
 />

Exemplo de código 2 (semanalmente)

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
   xmlns:jcr="http://www.jcp.org/jcr/1.0"
   jcr:primaryType="sling:Folder"
   sling:configCollectionInherit="true"
   sling:configPropertyInherit="true"
   windowEndTime="15:30"
   windowSchedule="weekly"
   windowScheduleWeekdays="[5,5]"
   windowStartTime="14:30"/>

Exemplo de código 3 (mensalmente)

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
   xmlns:jcr="http://www.jcp.org/jcr/1.0"
   jcr:primaryType="sling:Folder"
   sling:configCollectionInherit="true"
   sling:configPropertyInherit="true"
   windowEndTime="15:30"
   windowSchedule="monthly"
   windowFirstLastStartDay=0
   windowScheduleWeekdays="[5,5]"
   windowStartTime="14:30"/>

Tarefas de Manutenção de Limpeza de Versão e Limpeza de Log de Auditoria purge-tasks

A limpeza de versões e do log de auditoria reduz o tamanho do repositório e, em alguns cenários, pode melhorar o desempenho.

NOTE
Os clientes do AEM Guides não devem configurar a Limpeza de versão.

Padrões defaults

Atualmente, a limpeza não está habilitada por padrão, mas isso será alterado no futuro. Os ambientes criados antes da ativação da limpeza padrão terão um limite mais conservador para que a limpeza não ocorra inesperadamente. Consulte as seções Limpeza de versão e Limpeza de log de auditoria abaixo para obter mais detalhes sobre a política de limpeza padrão.

Os valores de limpeza padrão podem ser substituídos declarando um arquivo de configuração e implantando-o conforme descrito abaixo.

Aplicar uma configuração configure-purge

Declare um arquivo de configuração e implante-o conforme descrito nas etapas a seguir.

NOTE
Depois de implantar o nó de limpeza de versão no arquivo de configuração, você deve mantê-lo declarado e não removê-lo. O pipeline de configuração falhará se você tentar fazer isso.
Da mesma forma, depois de implantar o nó de expurgação do log de auditoria no arquivo de configuração, você deve mantê-lo declarado e não removê-lo.

1 - crie a seguinte pasta e estrutura de arquivo na pasta de nível superior do seu projeto no Git:

config/
     mt.yaml

2 - Declarar propriedades no arquivo de configuração, que incluem:

  • uma propriedade "kind" com o valor "MaintenanceTasks".
  • uma propriedade "version" (no momento, estamos na versão 1).
  • um objeto "metadata" opcional com a propriedade envTypes com uma lista separada por vírgulas do tipo de ambiente (dev, stage, prod) para o qual essa configuração é válida. Se nenhum objeto de metadados for declarado, a configuração será válida para todos os tipos de ambiente.
  • um objeto de dados com objetos versionPurge e auditLogPurge.

Consulte as definições e a sintaxe dos objetos versionPurge e auditLogPurge abaixo.

Você deve estruturar a configuração de forma semelhante ao seguinte exemplo:

kind: "MaintenanceTasks"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  versionPurge:
    maximumVersions: 15
    maximumAgeDays: 20
    paths: ["/content"]
    minimumVersions: 1
    retainLabelledVersions: false
  auditLogPurge:
    rules:
      - replication:
          maximumAgeDays: 15
          contentPath: "/content"
          types: ["Activate", "Deactivate", "Delete", "Test", "Reverse", "Internal Poll"]
      - pages:
          maximumAgeDays: 15
          contentPath: "/content"
          types: ["PageCreated", "PageModified", "PageMoved", "PageDeleted", "VersionCreated", "PageRestored", "PageValid", "PageInvalid"]
      - dam:
          maximumAgeDays: 15
          contentPath: "/content"
          types: ["ASSET_EXPIRING", "METADATA_UPDATED", "ASSET_EXPIRED", "ASSET_REMOVED", "RESTORED", "ASSET_MOVED", "ASSET_VIEWED", "PROJECT_VIEWED", "PUBLISHED_EXTERNAL", "COLLECTION_VIEWED", "VERSIONED", "ADDED_COMMENT", "RENDITION_UPDATED", "ACCEPTED", "DOWNLOADED", "SUBASSET_UPDATED", "SUBASSET_REMOVED", "ASSET_CREATED", "ASSET_SHARED", "RENDITION_REMOVED", "ASSET_PUBLISHED", "ORIGINAL_UPDATED", "RENDITION_DOWNLOADED", "REJECTED"]

Lembre-se de que para que a configuração seja válida:

  • todas as propriedades devem ser definidas. Não há padrões herdados.
  • os tipos (números inteiros, strings, booleanos etc.) nas tabelas de propriedades abaixo devem ser respeitados.
NOTE
Você pode usar o yq para validar localmente a formatação YAML do seu arquivo de configuração (por exemplo, yq mt.yaml).

3 - Configurar os pipelines de configuração de não produção e produção.

Os RDEs (Rapid Development Ambients, ambientes de desenvolvimento rápido) não oferecem suporte à limpeza. Para outros tipos de ambiente em programas de produção (que não sejam de sandbox), crie um pipeline de configuração de implantação direcionada no Cloud Manager.

Consulte configurando pipelines de produção e configurando pipelines de não produção para obter mais detalhes.

Remoção da versão version-purge

NOTE
Os clientes do AEM Guides não devem configurar a Limpeza de versão.

Padrões de Expurgação de Versão version-purge-defaults

Atualmente, a limpeza não está habilitada por padrão, mas isso será alterado no futuro.

Os ambientes criados após a ativação da limpeza padrão terão os seguintes valores padrão:

  • Versões com mais de 30 dias são removidas.
  • As cinco versões mais recentes nos últimos 30 dias são mantidas.
  • Independentemente das regras acima, a versão mais recente (além do arquivo atual) é preservada.

Os ambientes criados antes da limpeza padrão estarem habilitados terão os valores padrão listados abaixo, no entanto, é recomendável reduzir esses valores para otimizar o desempenho.

  • Versões com mais de 7 anos são removidas.
  • Todas as versões nos últimos sete anos são mantidas.
  • Após 7 anos, versões diferentes da versão mais recente (além do arquivo atual) são removidas.

Propriedades de limpeza de versão version-purge-properties

As propriedades permitidas estão listadas abaixo.

As colunas que indicam padrão indicam os valores padrão no futuro, quando os padrões são aplicados; TBD reflete uma ID de ambiente que ainda não foi determinada.

Propriedades
padrão futuro para envs>TBD
padrão futuro para envs<=TBD
obrigatório
tipo
Valores
caminhos
["/conteúdo"]
["/conteúdo"]
Sim
matriz de strings
Especifica em quais caminhos as versões serão removidas quando novas versões forem criadas. Os clientes devem declarar essa propriedade, mas o único valor permitido é "/content".
maximumAgeDays
30
2557 (7 anos + 2 dias bissextos)
Sim
Número inteiro
Qualquer versão anterior ao valor configurado é removida. Se o valor for 0, a limpeza não será executada com base na idade da versão.
maximumVersions
5
0 (sem limite)
Sim
Número inteiro
Qualquer versão anterior à n-ésima versão mais recente é removida. Se o valor for 0, a limpeza não será executada com base no número de versões.
minimumVersions
1
1
Sim
Número inteiro
O número mínimo de versões que são mantidas independentemente da idade. Observe que pelo menos 1 versão é sempre mantida; seu valor deve ser 1 ou superior.
keepLabelledVersioned
falso
falso
Sim
booleano
Determina se as versões rotuladas explicitamente serão excluídas da limpeza. Para obter uma melhor otimização do repositório, é recomendável definir esse valor como false.

Interações de propriedade

Os exemplos a seguir ilustram como as propriedades interagem quando combinadas.

Exemplo:

maximumAgeDays = 30
maximumVersions = 10
minimumVersions = 2

Se houver 11 versões no dia 23, a versão mais antiga será removida na próxima vez que a tarefa de manutenção de limpeza for executada, já que a propriedade maximumVersions está definida como 10.

Se houver 5 versões no dia 31, somente 3 serão removidas, pois a propriedade minimumVersions está definida como 2.

Exemplo:

maximumAgeDays = 30
maximumVersions = 0
minimumVersions = 1

Nenhuma versão com mais de 30 dias será removida, pois a propriedade maximumVersions está definida como 0.

Uma versão com mais de 30 dias será mantida.

Limpeza do log de auditoria audit-purge

Padrões de Expurgação de Log de Auditoria audit-purge-defaults

Atualmente, a limpeza não está habilitada por padrão, mas isso será alterado no futuro.

Os ambientes criados após a ativação da limpeza padrão terão os seguintes valores padrão:

  • Os logs de auditoria de replicação, DAM e página com mais de 7 dias são removidos.
  • Todos os eventos possíveis são registrados.

Os ambientes criados antes da limpeza padrão estarem habilitados terão os valores padrão listados abaixo, no entanto, é recomendável reduzir esses valores para otimizar o desempenho.

  • Replicação, DAM e logs de auditoria de página com mais de 7 anos são removidos.
  • Todos os eventos possíveis são registrados.
NOTE
Recomenda-se que os clientes que têm requisitos normativos para produzir logs de auditoria não editáveis se integrem a serviços externos especializados.

Propriedades de limpeza de log de auditoria audit-purge-properties

As propriedades permitidas estão listadas abaixo.

As colunas que indicam padrão indicam os valores padrão no futuro, quando os padrões são aplicados; TBD reflete uma ID de ambiente que ainda não foi determinada.

Propriedades
padrão futuro para envs>TBD
padrão futuro para envs<=TBD
obrigatório
tipo
Valores
regras
-
-
Sim
Objeto
Um ou mais dos seguintes nós: replicação, páginas, dam. Cada um desses nós define regras, com as propriedades abaixo. Todas as propriedades devem ser declaradas.
maximumAgeDays
7 dias
2557 (7 anos + 2 dias bissextos)
Sim
inteiro
Para replicação, páginas ou DAM: o número de dias que os logs de auditoria são mantidos. Os logs de auditoria anteriores ao valor configurado são removidos.
contentPath
"/content"
"/content"
Sim
String
O caminho sob o qual os logs de auditoria serão removidos para o tipo relacionado. Deve ser definido como "/content".
tipos
todos os valores
todos os valores
Sim
Matriz de enumeração
Para replicação, os valores enumerados são: Ativar, Desativar, Excluir, Testar, Reverter, Sondagem Interna. Para páginas, os valores enumerados são: PageCreated, PageModified, PageMoved, PageDeleted, VersionCreated, PageRestoring, PageRolled Out, PageValid, PageInvalid. Para dam, os valores enumerados são: ASSET_EXPIRING, METADATA_UPDATED, ASSET_EXPIRED, ASSET_REMOVED, RESTORED, ASSET_MOVED, ASSET_VIEWED, PROJECT_VIEWED, PUBLISHED_EXTERNAL, COLLECTION_VIEWED, VERSIONED, ADDED_COMMENT, RENDITION_UPDATED, ACCEPTED, DOWNLOADED, SUBASSET ATUALIZADO, SUBASSET_REMOVED, ASSET_CREATED, ASSET_SHARED, RENDITION_REMOVED, ASSET_PUBLISHED, ORIGINAL_UPDATED, RENDITION_DOWNLOADED, REJEITADO.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab