Como criar artefatos de pacote de configuração de máquina personalizados

Antes de começar, é uma boa ideia ler a página de visão geral da configuração da máquina.

A configuração da máquina usa a Configuração de Estado Desejado (DSC) ao auditar e configurar o Windows e o Linux. A configuração DSC define a condição em que o computador deverá estar.

Use as etapas a seguir para criar sua própria configuração para gerenciar o estado de uma máquina Azure ou não-Azure.

Instalar o PowerShell 7 e os módulos necessários do PowerShell

Primeiro, siga as etapas em Como configurar um ambiente de criação de configuração de máquina. Essas etapas ajudam você a instalar a versão necessária do PowerShell para seu sistema operacional, o módulo GuestConfiguration e o módulo PSDesiredStateConfiguration.

Criar uma configuração

Antes de criar um pacote de configuração, crie e compile uma configuração DSC. Exemplos de configurações estão disponíveis para Windows e Linux.

Este exemplo de configuração é para máquinas Windows. Ele configura a máquina para criar a MC_ENV_EXAMPLE variável de ambiente nos escopos Process e Machine . O valor da variável define como 'This was set by machine configuration'.

Configuration MyConfig {
    Import-DscResource -Name 'Environment' -ModuleName 'PSDscResources'
    Environment MachineConfigurationExample {
        Name   = 'MC_ENV_EXAMPLE'
        Value  = 'This was set by machine configuration'
        Ensure = 'Present'
        Target = @('Process', 'Machine')
    }
}

MyConfig

Com essa definição salva no arquivo de MyConfig.ps1 script, você pode executar o script para compilar a configuração.

. .\MyConfig.ps1

    Directory: C:\dsc\MyConfig

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           5/16/2023 10:39 AM           1080 localhost.mof

A configuração é compilada localhost.mof no arquivo na MyConfig pasta no diretório de trabalho atual. Renomeie localhost.mof para o nome que você deseja usar como o nome do pacote, como MyConfig.mof.

Rename-Item -Path .\MyConfig\localhost.mof -NewName MyConfig.mof -PassThru

    Directory: C:\dsc\MyConfig

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           5/16/2023 10:40 AM           1080 MyConfig.mof

Criar um artefato de pacote de configuração

Uma vez que o MOF é compilado, os arquivos de suporte devem ser empacotados juntos. O pacote concluído é usado pela configuração da máquina para criar as definições de Política do Azure.

O New-GuestConfigurationPackage cmdlet cria o pacote. Os módulos exigidos pela configuração devem estar disponíveis no $Env:PSModulePath ambiente de desenvolvimento para que os comandos no módulo possam adicioná-los ao pacote.

Parâmetros do cmdlet ao New-GuestConfigurationPackage criar conteúdo do Windows:

• Nome: nome do pacote de configuração da máquina.
• Configuração: Caminho completo do documento de configuração DSC compilado.
• Caminho: Caminho da pasta de saída. Este parâmetro é opcional. Se não for especificado, o pacote será criado no diretório atual.
• Tipo: (Audit, AuditandSet) Determina se a configuração deve apenas auditar ou se a configuração deve alterar o estado da máquina se estiver fora do estado desejado. A predefinição é Audit.
• FrequencyMinutes: A frequência de avaliação da embalagem na máquina em minutos.
• FilesToInclude: Uma lista de matriz de caminhos para arquivos adicionais a serem incluídos no pacote gerado.

Esta etapa não requer elevação. O parâmetro Force é usado para substituir pacotes existentes, se você executar o comando mais de uma vez.

Os comandos a seguir criam um artefato de pacote:

# Create a package that will only audit compliance
$params = @{
    Name          = 'MyConfig'
    Configuration = './MyConfig/MyConfig.mof'
    Type          = 'Audit'
    Force         = $true
}
New-GuestConfigurationPackage @params

# Create a package that will audit and apply the configuration (Set)
$params = @{
    Name          = 'MyConfig'
    Configuration = './MyConfig/MyConfig.mof'
    Type          = 'AuditAndSet'
    Force         = $true
}
New-GuestConfigurationPackage @params

Um objeto é retornado com o Nome e o Caminho do pacote criado.

Name     Path
----     ----
MyConfig C:\dsc\MyConfig.zip

Conteúdo esperado de um artefato de configuração de máquina

O pacote concluído é usado pela configuração da máquina para criar as definições de Política do Azure. O pacote é composto por:

• A configuração DSC compilada como um MOF
• Pasta Módulos
  • Módulo GuestConfiguration
  • Módulo DscNativeResources
  • Módulos de recursos DSC exigidos pelo MOF
• Um arquivo de metaconfiguração que armazena o pacote type e version

O cmdlet do PowerShell cria o arquivo de pacote .zip . Nenhuma pasta de nível raiz ou pasta de versão é necessária. O formato do pacote deve ser um .zip arquivo e não pode exceder um tamanho total de 100 MB quando descompactado.

Você pode expandir o arquivo para inspecioná-lo usando o Expand-Archive cmdlet.

Expand-Archive -Path .\MyConfig.zip -DestinationPath MyConfigZip

Você pode obter o tamanho total do pacote não compactado com o PowerShell.

Get-ChildItem -Recurse -Path .\MyConfigZip |
    Measure-Object -Sum Length |
    ForEach-Object -Process {
        $Size = [math]::Round(($_.Sum / 1MB), 2)
        "$Size MB"
    }

Estendendo a configuração da máquina com ferramentas de terceiros

Os pacotes de artefatos para configuração de máquina podem ser estendidos para incluir ferramentas de terceiros. A extensão da configuração da máquina requer o desenvolvimento de dois componentes.

• Um recurso de Configuração de Estado Desejado que lida com todas as atividades relacionadas ao gerenciamento da ferramenta de terceiros
  • Instalar
  • Invocar
  • Converter saída
• Conteúdo no formato correto para a ferramenta consumir nativamente

O recurso DSC requer desenvolvimento personalizado se uma solução de comunidade ainda não existir. As soluções da comunidade podem ser descobertas pesquisando a tag GuestConfiguration na Galeria do PowerShell.

Depois que o recurso DSC tiver sido instalado no ambiente de desenvolvimento, use o parâmetro FilesToInclude para New-GuestConfigurationPackage incluir conteúdo para a plataforma de terceiros no artefato de conteúdo.

Próximo passo