Gerenciador de pacotes working-with-packages
Os pacotes permitem importar e exportar conteúdo do repositório. Você pode usar pacotes para instalar novo conteúdo, instalar nova funcionalidade, transferir conteúdo entre instâncias e fazer backup do conteúdo do repositório.
Com o Gerenciador de pacotes, é possível transferir pacotes entre a instância do AEM e o sistema de arquivos local para fins de desenvolvimento.
O que são pacotes? what-are-packages
Um pacote é um arquivo zip que contém o conteúdo do repositório no formato de serialização de sistemas de arquivos, chamado de serialização do Vault, fornecendo uma representação fácil de usar e editar de arquivos e pastas. O conteúdo incluído no pacote é definido usando filtros.
Um pacote também contém informações meta do Vault, incluindo as definições de filtro e as informações de configuração de importação. As propriedades de conteúdo adicionais, que não são usadas para a extração de pacotes, podem ser incluídas no pacote, como uma descrição, uma imagem visual ou um ícone. Essas propriedades de conteúdo adicionais são apenas para o consumidor do pacote de conteúdo e para fins informativos.
Gerenciador de pacotes package-manager
O Gerenciador de pacotes gerencia os pacotes na instalação do AEM. Depois de atribuir as permissões necessárias, você poderá usar o Gerenciador de Pacotes para várias ações, incluindo configuração, compilação, download e instalação de pacotes.
Permissões necessárias required-permissions
Para criar, modificar, fazer upload e instalar pacotes, os usuários devem ter as permissões apropriadas nos seguintes nós:
- Direitos completos excluindo exclusão em
/etc/packages
- O nó que contém o conteúdo do pacote
Acessar o Gerenciador de pacotes accessing
Você pode acessar o Gerenciador de pacotes de três maneiras:
- No menu principal do AEM > Ferramentas > Implantação > Pacotes
- De CRXDE Lite usando a barra do alternador superior
- Acessando diretamente
http://<host>:<port>/crx/packmgr/
Interface do usuário do Gerenciador de pacotes ui
O Gerenciador de pacotes está dividido em quatro áreas funcionais principais:
-
Painel de Navegação à Esquerda - Esse painel permite filtrar e classificar a lista de pacotes.
-
Lista de Pacotes - Esta é a lista de pacotes na sua instância filtrada e classificada de acordo com as seleções no Painel de Navegação Esquerdo.
-
Log de atividades - Esse painel é minimizado no início e expande-se para detalhar a atividade do Gerenciador de Pacotes, por exemplo, quando um pacote é compilado ou instalado. Há botões adicionais na guia Registro de atividades para:
- Limpar Log
- Mostrar/Ocultar
-
Barra de Ferramentas - A barra de ferramentas contém botões de atualização para o Painel de Navegação Esquerdo e a lista de Pacotes, além de botões para pesquisar, criar e carregar pacotes.
Clicar em uma opção no Painel de navegação esquerdo filtra imediatamente a Lista de pacotes.
Clicar em um nome de pacote expande a entrada na Lista de pacotes para mostrar mais detalhes sobre o pacote.
Há várias ações que podem ser executadas em um pacote por meio dos botões da barra de ferramentas disponíveis quando os detalhes do pacote são expandidos.
Outras ações estão disponíveis abaixo do botão Mais.
Status do pacote package-status
Cada entrada na lista de pacotes tem um indicador de status para informar rapidamente o status do pacote. Passar o mouse sobre o status revela uma dica de ferramenta com os detalhes do status.
Se o pacote tiver sido alterado ou nunca tiver sido criado, o status será apresentado como um link para executar uma ação rápida para recriar ou instalar o pacote.
Configurações do pacote package-settings
Um pacote é essencialmente um conjunto de filtros e os dados do repositório com base nesses filtros. Usando a interface do usuário do Gerenciador de Pacotes, você pode clicar em um pacote e no botão Editar para exibir os detalhes de um pacote, incluindo as configurações a seguir.
Configurações gerais general-settings
É possível editar uma variedade de configurações de pacote para definir informações como descrição do pacote, dependências e detalhes do provedor.
A caixa de diálogo Configurações de Pacote está disponível por meio do botão Editar ao criar ou editar um pacote. Depois que as alterações forem feitas, clique em Salvar.
Miniaturas do pacote thumbnails
Uma miniatura fornece uma representação visual de referência rápida do que o pacote contém. Isso é mostrado na lista de pacotes e pode ajudar a identificar facilmente o pacote ou a classe do pacote.
A seguir estão exemplos de convenções usadas para pacotes oficiais:
Hotfix oficial
Instalação oficial do AEM de extensão
Service Pack Oficial
Use um ícone exclusivo para seu pacote. Não reutilize um ícone usado pelo Adobe.
Filtros do pacote package-filters
Os filtros identificam os nós de repositório a serem incluídos no pacote. Uma Definição de Filtro especifica as seguintes informações:
- O Caminho raiz do conteúdo a ser incluído
- Regras que incluem ou excluem nós específicos abaixo do caminho raiz
Adicionar regras usando o botão +. Remova regras usando o botão -.
As regras são aplicadas de acordo com sua ordem, portanto, posicione-as conforme necessário usando os botões de seta Para cima e Para baixo.
Os filtros podem incluir zero ou mais regras. Quando nenhuma regra é definida, o pacote contém todo o conteúdo abaixo do caminho raiz.
É possível definir uma ou mais definições de filtro para um pacote. Use mais de um filtro para incluir conteúdo de vários caminhos raiz.
Ao criar regras, você define uma expressão regular (também conhecida como regex, regexp ou expressão racional) para especificar todos os nós que deseja incluir ou excluir.
Os filtros de pacote geralmente são definidos quando você cria o pacote pela primeira vez. No entanto, eles também podem ser editados mais tarde, depois disso, o pacote deve ser recriado para atualizar seu conteúdo com base nas novas definições de filtro.
Dependências dependencies
6.5
groupId:name:version
groupId:name:version
Configurações avançadas advanced-settings
WKND Media Group
https://wknd.site
https://wknd.site/package/
Reiniciar - o AEM deve ser reiniciado após a instalação do pacote
Substituir - Substituir ACLs no repositório
Mesclar - Mesclar ambos os conjuntos de ACLs
MergePreserve - Mesclar o controle de acesso no conteúdo com o fornecido com o pacote, adicionando as entradas de controle de acesso das entidades de segurança não presentes no conteúdo
Limpar - Limpar ACLs
Capturas de tela do pacote package-screenshots
Você pode anexar várias capturas de tela ao seu pacote para fornecer uma representação visual de como o conteúdo aparece.
Ações do pacote package-actions
Há muitas ações que podem ser executadas em um pacote.
Criação de um pacote creating-a-new-package
-
Clique em Criar Pacote.
note tip TIP Se a instância tiver muitos pacotes, talvez haja uma estrutura de pastas em vigor. Nesses casos, é mais fácil navegar até a pasta de destino necessária antes de criar o novo pacote. -
Na caixa de diálogo Novo Pacote, insira os seguintes campos:
-
Nome do Pacote - Selecione um nome descritivo para ajudá-lo (e a outras pessoas) a identificar facilmente o conteúdo do pacote.
-
Versão - Este é um campo textual para que você indique uma versão. Ele é anexado ao nome do pacote para formar o nome do arquivo zip.
-
Grupo - Este é o nome do grupo (ou pasta) de destino. Os grupos ajudam a organizar seus pacotes. Uma pasta é criada para o grupo se ele ainda não existir. Se você deixar o nome do grupo em branco, ele criará o pacote na lista de pacotes principal.
-
-
Clique em OK para criar o pacote.
-
O AEM lista o novo pacote no topo da lista de pacotes.
-
Clique em Editar para definir o conteúdo do pacote . Clique em Salvar depois que terminar de editar as configurações.
-
Agora você pode Criar seu pacote.
Não é obrigatório criar o pacote imediatamente após criá-lo. Um pacote não criado não tem conteúdo e consiste apenas nos dados de filtro e outros metadados do pacote.
Criação de um pacote building-a-package
Um pacote é frequentemente criado ao mesmo tempo em que você cria o pacote, mas você pode retornar posteriormente para compilar ou recompilar o pacote. Isso pode ser útil se o conteúdo no repositório tiver sido alterado ou os filtros do pacote tiverem sido alterados.
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Clique em Build. Uma caixa de diálogo solicita a confirmação de que você deseja criar o pacote, pois qualquer conteúdo existente será substituído.
-
Clique em OK. O AEM cria o pacote, listando todo o conteúdo adicionado ao pacote como faz na lista de atividades. Quando concluído, o AEM exibe uma confirmação de que o pacote foi criado e (quando você fecha a caixa de diálogo) atualiza as informações da lista de pacotes.
Editar um pacote edit-package
Depois que um pacote for carregado para AEM, você poderá modificar suas configurações.
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Clique em Editar e atualize as Configurações de Pacote conforme necessário.
-
Clique em Salvar para salvar.
Talvez seja necessário recompilar o pacote para atualizar seu conteúdo com base nas alterações feitas.
Reencapsulamento de um pacote rewrapping-a-package
Depois que um pacote é criado, ele pode ser empacotado novamente. Reajustar altera as informações do pacote sem alterar a miniatura, a descrição etc., sem alterar o conteúdo do pacote.
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Clique em Editar e atualize as Configurações de Pacote conforme necessário.
-
Clique em Salvar para salvar.
-
Clique em Mais > Reajustar e uma caixa de diálogo pedirá confirmação.
Exibindo Outras Versões do Pacote other-versions
Como cada versão de um pacote aparece na lista como qualquer outro pacote, o Gerenciador de pacotes pode encontrar outras versões de um pacote selecionado.
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Clique em Mais > Outras versões e uma caixa de diálogo será aberta com uma lista de outras versões do mesmo pacote com informações de status.
Visualizando o conteúdo do pacote e testando a instalação viewing-package-contents-and-testing-installation
Depois que um pacote for criado, é possível visualizar o conteúdo.
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Para exibir o conteúdo, clique em Mais > Conteúdo, e o Gerenciador de Pacotes listará todo o conteúdo do pacote no log de atividades.
-
Para executar a instalação a seco, clique em Mais > Testar Instalação e nos relatórios do Gerenciador de Pacotes no log de atividades para exibir os resultados como se a instalação tivesse sido executada.
Fazendo download de pacotes para seu sistema de arquivos downloading-packages-to-your-file-system
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Clique no botão Download ou no nome de arquivo vinculado do pacote na área de detalhes do pacote.
-
O AEM baixa o pacote para o computador.
Compartilhamento de um pacote share
O Package Share era um serviço público centralizado para distribuir pacotes de conteúdo. O Compartilhamento de Pacotes foi substituído por Distribuição de Software e este botão não funciona mais.
Fazer upload de pacotes do seu sistema de arquivos uploading-packages-from-your-file-system
-
Selecione a pasta de grupo na qual deseja que o pacote seja carregado.
-
Clique no botão Carregar pacote.
-
Forneça as informações necessárias sobre o pacote carregado.
- Pacote - Use o botão Procurar… para selecionar o pacote necessário no sistema de arquivos local.
- Forçar Carregamento - Se um pacote com esse nome já existir, essa opção forçará o carregamento e substituirá o pacote existente.
-
Clique em OK e o pacote selecionado será carregado e a lista de pacotes será atualizada adequadamente.
O conteúdo do pacote agora existe no AEM, mas para disponibilizá-lo para uso, certifique-se de instalar o pacote.
Validação de pacotes validating-packages
Como os pacotes podem modificar o conteúdo existente, geralmente é útil validar essas alterações antes de instalar.
Opções de validação validation-options
O Gerenciador de pacotes pode executar as seguintes validações:
Validar importações do pacote OSGi osgi-package-imports
O que está marcado
Essa validação inspeciona o pacote de todos os arquivos JAR (pacotes OSGi), extrai seus manifest.xml
(que contêm as dependências com versão das quais o pacote OSGi depende) e verifica as exportações da instância AEM para essas dependências com as versões corretas.
Como é relatado
Todas as dependências com versão que não podem ser satisfeitas pela instância AEM são listadas no Log de atividades do Gerenciador de pacotes.
Estados de erro
Se as dependências não forem satisfeitas, os pacotes OSGi no pacote com essas dependências não serão iniciados. Isso resulta em uma implantação de aplicativo com falha, pois qualquer item que depende do pacote OSGi não iniciado não funcionará corretamente.
Resolução do Erro
Para resolver erros devido a pacotes OSGi não satisfeitos, a versão de dependência no pacote com importações não satisfeitas deve ser ajustada.
Validar sobreposições overlays
O que está marcado
Essa validação determina se o pacote que está sendo instalado contém um arquivo que já está sobreposto na instância AEM de destino.
Por exemplo, dada uma sobreposição existente em /apps/sling/servlet/errorhandler/404.jsp
, um pacote que contém /libs/sling/servlet/errorhandler/404.jsp
, tal que irá alterar o arquivo existente em /libs/sling/servlet/errorhandler/404.jsp
.
Como é exportado
Essas sobreposições são descritas no Log de atividades do Gerenciador de pacotes.
Estados de erro
Um estado de erro significa que o pacote está tentando implantar um arquivo que já está sobreposto, portanto, as alterações no pacote serão substituídas (e, portanto, "ocultas") pela sobreposição e não terão efeito.
Resolução do Erro
Para resolver esse problema, o mantenedor do arquivo de sobreposição em /apps
deve revisar as alterações no arquivo sobreposto em /libs
, incorporar as alterações conforme necessário na sobreposição ( /apps
) e reimplantar o arquivo sobreposto.
Validar ACLs acls
O que está marcado
Essa validação verifica quais permissões estão sendo adicionadas, como elas serão tratadas (mesclar/substituir) e se as permissões atuais serão afetadas.
Como é relatado
As permissões são descritas no Log de atividades do Gerenciador de pacotes.
Estados de erro
Nenhum erro explícito pode ser fornecido. A validação simplesmente indica se qualquer nova permissão de ACL será adicionada ou afetada pela instalação do pacote.
Resolução do Erro
Usando as informações fornecidas pela validação, os nós afetados podem ser revisados no CRXDE e as ACLs podem ser ajustadas no pacote conforme necessário.
Executando validação performing-validation
A validação de pacotes pode ser feita de duas maneiras diferentes:
A validação sempre deve ocorrer após o upload do pacote, mas antes de instalá-lo.
Validação De Pacote Via Gerenciador De Pacotes via-package-manager
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Para validar o pacote, clique em Mais > Validar,
-
Na caixa de diálogo modal exibida, use as caixas de seleção para selecionar o(s) tipo(s) de validação e iniciar a validação clicando em Validar.
-
A(s) validação(s) escolhida(s) é/são executada(s) e os resultados são exibidos no Log de atividades do Gerenciador de pacotes.
Validação de pacote por meio de solicitação POST HTTP via-post-request
A solicitação POST assume o seguinte formato.
https://<host>:<port>/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls
O parâmetro type
pode ser qualquer lista não ordenada separada por vírgulas formada por:
osgiPackageImports
overlays
acls
O valor padrão de type
é osgiPackageImports
, caso não seja explicitamente passado.
Ao usar cURL, execute uma instrução semelhante à seguinte:
curl -v -X POST --user admin:admin -F file=@/Users/SomeGuy/Desktop/core.wcm.components.all-1.1.0.zip 'http://localhost:4502/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls'
Ao validar por meio da solicitação POST, a resposta é enviada de volta como um objeto JSON.
Visualizando a cobertura do pacote package-coverage
Os pacotes são definidos por seus filtros. O Gerenciador de pacotes pode aplicar filtros de um pacote ao conteúdo existente do repositório para mostrar qual conteúdo do repositório é coberto pela definição de filtro do pacote.
-
Abra os detalhes do pacote na lista de pacotes clicando no nome do pacote.
-
Clique em Mais > Cobertura.
-
Os detalhes da cobertura estão listados no Log de atividades.
Instalação de pacotes installing-packages
Fazer upload de um pacote adiciona somente o conteúdo do pacote ao repositório, mas ele não está acessível. Instale o pacote carregado para usar o conteúdo do pacote.
Antes da instalação do pacote, o Gerenciador de pacotes cria automaticamente um pacote de instantâneos que contém o conteúdo que será substituído. Este snapshot será reinstalado se você desinstalar o pacote.
- Se estiver instalando ativos digitais, você deve:
Primeiro, desative o WorkflowLauncher.
Use a opção de menu Componentes do console OSGi para desativarcom.day.cq.workflow.launcher.impl.WorkflowLauncherImpl.
- Em seguida, quando a instalação estiver concluída, reative o WorkflowLauncher.
-
Abra os detalhes do pacote que deseja instalar na lista de pacotes clicando no nome do pacote.
-
Clique no botão Instalar nos detalhes do item ou no link Instalar no status do pacote.
-
Uma caixa de diálogo solicitará confirmação e permitirá a especificação de opções adicionais.
- Extrair Somente - Extraia o pacote somente para que nenhum instantâneo seja criado e, portanto, a desinstalação não seja possível
- Limite de Salvamento - Número de nós transitórios até que o salvamento automático seja acionado (aumente se você encontrar exceções de modificação simultâneas)
- Extrair Subpacotes - Habilitar a extração automática de subpacotes
- Manipulação de Controle de Acesso - Especifica como as informações de controle de acesso definidas no pacote são tratadas quando o pacote é instalado (as opções são iguais às configurações avançadas do pacote)
- Tratamento de Dependências - Especifique como as dependências são tratadas durante a instalação
-
Clique em Instalar.
-
O Registro de atividades detalha o progresso da instalação.
Quando a instalação for concluída com êxito, a lista de pacotes será atualizada e a palavra Instalado aparecerá no status do pacote.
Reinstalação de pacotes reinstalling-packages
A reinstalação de pacotes executa as mesmas etapas em um pacote já instalado que são processadas quando o instala inicialmente o pacote.
Upload e instalação baseados no sistema de arquivos file-system-based-upload-and-installation
Você pode abandonar o Gerenciador de pacotes completamente ao instalar pacotes. O AEM pode detectar pacotes colocados em um local específico no sistema de arquivos local da máquina host, carregá-los e instalá-los automaticamente.
-
Na pasta de instalação do AEM, há uma pasta
crx-quicksart
ao lado do jar e do arquivolicense.properties
. Crie uma pasta chamadainstall
emcrx-quickstart
, resultando no caminho<aem-home>/crx-quickstart/install
. -
Nesta pasta, adicione seus pacotes. Eles serão carregados e instalados automaticamente na sua instância.
-
Quando o upload e a instalação estiverem concluídos, você poderá ver os pacotes no Gerenciador de pacotes como se tivesse usado a interface do usuário do Gerenciador de pacotes para instalá-los.
Se a instância estiver em execução, o carregamento e a instalação serão iniciados imediatamente quando você adicioná-los ao pacote na pasta install
Se a instância não estiver em execução, os pacotes colocados na pasta install
serão instalados na inicialização em ordem alfabética.
Desinstalando pacotes uninstalling-packages
A desinstalação do pacote reverte o conteúdo do repositório para o instantâneo criado automaticamente pelo Gerenciador de Pacotes antes da instalação.
-
Abra os detalhes do pacote que deseja desinstalar na lista de pacotes clicando no nome do pacote.
-
Clique em Mais > Desinstalar para remover o conteúdo deste pacote do repositório.
-
Uma caixa de diálogo solicitará confirmação e listará todas as alterações que estão sendo feitas.
-
O pacote é removido e o instantâneo é aplicado. O progresso do processo é mostrado no Log de atividades.
Exclusão de pacotes deleting-packages
A exclusão de um pacote exclui somente seus detalhes do Gerenciador de pacotes. Se esse pacote já tiver sido instalado, o conteúdo instalado não será excluído.
-
Abra os detalhes do pacote que deseja excluir na lista de pacotes clicando no nome do pacote.
-
O Gerenciador de pacotes solicita a confirmação de que você deseja excluir o pacote. Clique em OK para confirmar a exclusão.
-
As informações do pacote são excluídas e os detalhes são relatados no Log de atividades.
Replicação de pacotes replicating-packages
Replicar o conteúdo de um pacote para instalá-lo na instância de publicação.
-
Abra os detalhes do pacote que deseja replicar na lista de pacotes clicando no nome do pacote.
-
Clique em Mais > Replicar.
-
O pacote é replicado e os detalhes são relatados no Registro de atividades.
Distribuição de software software-distribution
Os pacotes AEM podem ser usados para criar e compartilhar conteúdo em ambientes AEM.
A Distribuição de Software é um serviço centralizado criado para simplificar a pesquisa e o download de pacotes AEM.
Para obter mais informações, consulte a documentação de Distribuição de Software.