Como administrador de nuvem ou projeto, você tem uma convenção de nomenclatura prescrita para recursos no seu ambiente e deseja que o recurso implantado siga essas convenções sem a interação dos usuários. Você pode criar modelos de nomenclatura globais para algumas ou todas as implantações no Automation Assembler.

Você pode começar criando nomes personalizados em nível de projeto ou nomes no nível da organização. Os nomes personalizados no nível do projeto têm precedência sobre os nomes no nível da organização. Este exemplo começa com um nome personalizado de organização simples e, em seguida, adiciona o nome em nível de projeto.

Cuidado: Se você tiver modelos de nuvem ou estiver usando a API onde você implanta 2.000 ou mais recursos ao mesmo tempo por projeto e onde um nome personalizado é aplicado, poderá encontrar um erro de Retries exhausted durante a implantação em alguns desses recursos. Se esse cenário for comum, você não deverá aplicar o novo nome personalizado aos projetos ou organizações em que isso ocorre. Em vez disso, você deve usar a nomenclatura do sistema padrão, não a opção de nomenclatura personalizada.

O que fazer primeiro

Criar um modelo personalizado no nível da organização

Quando você quiser um modelo de nome personalizado padrão para implantações que não têm modelos em nível de projeto, crie modelos organizacionais no escopo.

  1. Selecione Infraestrutura > Administração > Nomes Personalizados e clique em Novo Nome Personalizado.
  2. Insira um Nome.

    Este exemplo usa Prefixo e Carimbo de Data/Hora para a Organização.

  3. Selecione Organização como Escopo.
  4. Clique Novo Modelo de Nomenclatura e configure as seguintes opções.
    Opção Valor de amostra
    Tipo de recurso Máquina
    Validar nome de computação para exclusividade

    Marque a caixa de seleção.

    Nomes de recursos exclusivos garantem que você nunca se confunda sobre com qual recurso está trabalhando, mesmo quando trabalha em ambientes baseados em API.

    A configuração de número no seguinte formato de modelo é incrementada para garantir a exclusiveidade.

    Formato do modelo mcm-${timestamp}-${######}
    Valor de contador inicial 1
    Etapa de incremento 1

    Com essa configuração, todas as implantações em todos os projetos aumentarão a partir desse ponto de partida.

    Neste exemplo, em que o contador de início é 1 e o incremento é 1, a primeira implantação é numerada como 2. Você precisa que a implantação comece em 1. Em seguida, defina o contador de início como zero e a etapa de incremento como 1.

  5. Clique em Adicionar.
  6. Continue adicionando modelos para outros tipos de recursos usando os exemplos a seguir.
    Nome do Tipo de Recurso Formato do Modelo de Nomenclatura
    Máquina mcm-${timestamp}-${##}
    Rede ntw-${timestamp}-${##}
    Armazenamento stg-${timestamp}-${##}
    Balanceador de Carga ldb-${timestamp}-${##}
    Grupo de Recursos rsg-${timestamp}-${##}
    Gateway gtw-${timestamp}-${##}
    NAT nat-${timestamp}-${##}
    Grupo de Segurança scg-${timestamp}-${##}
  7. Clique em Criar.
  8. Teste o modelo de nome implantando modelos que incluem os tipos de recursos definidos.
    O recurso implantado que mostra o nome personalizado no nível da organização.

Criar um modelo personalizado de nível de projeto com correspondência de padrão avançada

Você pode criar um único modelo de nome personalizado que pode ser atribuído a diferentes projetos. Você usa a opção avançada para definir diferentes pontos de início de numeração para diferentes projetos.

Este exemplo usa o recurso de máquina do.

  1. Selecione Infraestrutura > Administração > Nomes Personalizados e clique em Novo Nome Personalizado.
  2. Insira um Nome.

    Este exemplo usa Nome do Projeto com Numeração Avançada.

  3. Selecione Projeto como o Escopo.
  4. Clique Novo Modelo de Nomenclatura e configure as seguintes opções.
    Opção Valor de amostra
    Tipo de recurso Máquina
    Formato do modelo ${project.name}-${######}
    Valor de contador inicial 1
    Etapa de incremento 1

    Com essa configuração, as implantações nos projetos atribuídos aumentarão a partir desse ponto de partida.

    Neste exemplo, em que o contador de início é 1 e o incremento é 1, a primeira implantação é numerada como 2. Você precisa que a implantação comece em 1. Em seguida, defina o contador de início como zero e a etapa de incremento como 1. Com 1 como valor inicial, o ProjetoA começa com 2 e o ProjetoB começa com 2, a menos que o valor seja substituído por um valor de padrão de correspondência avançado.

  5. Para adicionar mais refinamento ao modelo de nomenclatura de organização padrão, clique em Avançado e clique em Adicionar Padrão de Correspondência.

    Você pode definir padrões de nomenclatura diferentes para iniciar o contador em números diferentes ou redefinir o número para 1 para cada padrão. Por exemplo, a numeração do projeto de Vendas começa em 100 e a numeração do projeto de Marketing começa em 200.

    1. Insira o padrão para o projeto de vendas.
      Opção Valor de amostra
      Texto do padrão Vendas–
      Valor de contador inicial 100
    2. Insira o padrão para o projeto de marketing.
      Opção Valor de amostra
      Texto do padrão Marketing-
      Valor de contador inicial 200
  6. Clique em Adicionar.
  7. Continue adicionando modelos para outros tipos de recursos, conforme necessário.
  8. Clique em Atribuição de Projetos para adicionar os projetos de Vendas e Marketing.
  9. Clique em Criar.
  10. Teste o modelo de nome implantando primeiro um modelo de nuvem que esteja no projeto de Vendas e, em seguida, um no projeto de Marketing.
    O recurso implantado que mostra o nome personalizado no nível do projeto referente ao projeto de vendas.

Exemplo de um nome personalizado com propriedades personalizadas e valores específicos do projeto

Além das propriedades fornecidas nas opções de preenchimento automático no formato de modelo, você pode usar propriedades personalizadas. Para usar propriedades personalizadas em um nome personalizado, você deve defini-las em um grupo de propriedades.

Um valor de propriedade personalizada no modelo de nuvem tem precedência sobre o mesmo valor de propriedade no nome personalizado.

Este exemplo usa costCenter como propriedade e SalesCost como o valor para o projeto de Vendas e MktCost como o valor para o projeto de Marketing.

  1. Crie um grupo de propriedades chamado costingPG.
    1. Selecione Infraestrutura > Design > Grupos de Propriedade e clique em Novo Grupo de Propriedades.
    2. Clique em Valores de Entrada.
    3. Digite o Nome costingPG.
    4. Para obter o Escopo, selecione Disponível para qualquer projeto.
    5. Clique em Nova Propriedade, configure os valores abaixo e digite o nome costCenter.
      Opções Valores de Amostra
      Nome costCenter
      Tipo Cadeia de caracteres
      Valor padrão pesquisa
    6. Clique em Criar.
    7. Clique em Criar para salvar o novo grupo de propriedade.
  2. Configure as propriedades personalizadas para o projeto de Vendas e o projeto Marketing.

    Essas etapas ilustram o processo do projeto de Vendas. Você pode repetir as etapas e usar os valores do projeto de marketing.

    • Nome da propriedade de vendas: costingPG.costCenter. Valor: SalesCost.
    • Nome da propriedade de marketing: costingPG.costCenter. Valor: MktCost.
    1. Selecione Infraestrutura > Administração > Projetos e abra o projeto de Vendas.
    2. Clique na guia Provisionamento e localize a seção Propriedades Personalizadas.
    3. Digite costingPG.costCenter nome da propriedade e SalesCost e o valor.
      O valor da propriedade personalizada costingPG.costCenter e SalesCost na seção Propriedades personalizadas da guia Provisionamento do projeto.
    4. Clique em Salvar.
    5. Repita o processo no projeto de Marketing MktCost o valor da propriedade.
  3. Crie um nome personalizado em nível de projeto.

    Este exemplo utiliza os mesmos projetos que os usuários de exemplo avançado. Você pode atribuir nomes personalizados a apenas um projeto por vez. Para testar os resultados desse exemplo, você pode aplicar o nome personalizado a novos projetos ou remover os projetos de Vendas e Marketing do exemplo Nome do Projeto com Numeração Avançada.

    Este exemplo considera que você ainda não tenha atribuído os projetos de Vendas e Marketing.

    1. Selecione Infraestrutura > Administração > Nomes Personalizados e clique em Novo Nome Personalizado.
    2. Digite Nome do Projeto e costingPG como Nome.
    3. Selecione Projeto como o Escopo.
    4. Clique Novo Modelo de Nomenclatura e configure as seguintes opções.
      Tabela 1.
      Opção Valor
      Tipo de Recurso Máquina
      Formato do modelo ${project.name}-${costingPG.costCenter}-${######}
      Valor de contador inicial 1
      Etapa de incremento 1
    5. Clique em Adicionar.
    6. Clique em Atribuição de Projetos para adicionar os projetos de Vendas e Marketing.
    7. Clique em Criar.
  4. Teste o modelo de nome implantando primeiro um modelo de nuvem que esteja no projeto de Vendas e, em seguida, um no projeto de Marketing.
    Figura 1. Nome do recurso de projeto de vendas

    Os detalhes da implantação mostrando o nome do recurso como Sales-SalesCost-000002.
    Figura 2. Nome do recurso de projeto de marketing

    Os detalhes da implantação mostrando o nome do recurso como Marketing-MktCost-000002.

Exemplo de um nome personalizado com entradas de usuário de grupo de propriedades e modelo de nuvem

Este exemplo mostra como criar um nome personalizado com base nas entradas do usuário no modelo. Você define duas das entradas do usuário, sistema operacional e tamanho, no modelo de nuvem. Uma das entradas do usuário, mktSite, usa uma propriedade personalizada site.siteCode que aceita entradas do usuário, e você a adiciona ao modelo de nuvem.

  1. Defina a propriedade personalizada para o projeto de marketing.
    1. Selecione Infraestrutura > Design > Grupos de Propriedade e clique em Novo Grupo de Propriedades.
    2. Clique em Valores de Entrada.
    3. Nomeie e descreva o grupo de propriedades.
      Opção Valor
      Nome site
      Escopo

      Disponível para qualquer projeto.

      O grupo de propriedades deve estar geralmente disponível para que a propriedade esteja disponível para uso no formato de modelo de nome personalizado.

    4. Clique em Nova Propriedade e configure os seguintes valores.
      Opção Valor
      Nome siteCode
      Tipo Cadeia de caracteres
      Valor padrão Oeste
      Mais opções > Valor de enumeração

      Insira valores separados para Leste, Oeste, Norte e Sul.

      Esses valores representam os possíveis códigos de site que seus usuários podem selecionar.

  2. Crie o modelo de nomenclatura personalizado.
    1. Selecione Infraestrutura > Nomes Personalizados > Novo Nome Personalizado.
    2. Insira o Nome Site-OS-Size for Marketing Project.
    3. Selecione Projetos.

      A opção Projetos será selecionada e seria a única opção se você já tiver um nome personalizado com escopo da organização.

    4. Clique Novo Modelo de Nomenclatura e configure as seguintes opções.
      Opção Valor
      Tipo de recurso Máquina
      Formato do modelo

      ${site.siteCode}-${resource.name}-${######}

      A propriedade site.siteCode é aquela que você definiu na etapa anterior. O resource.name é definido no modelo de nuvem na próxima etapa.

      Valor de contador inicial 1
      Etapa de incremento 1
  3. Defina as entradas do usuário no modelo.

    As entradas do usuário incluídas neste exemplo incluem sistema operacional e tamanho, e uma entrada do usuário com base na propriedade personalizada site.siteCode.

    O modelo de nuvem nesta etapa é simples para fins de demonstração. Você pode aplicar o exemplo a um dos seus modelos existentes.

    1. Selecione Design > Novo a partir de > Tela em branco.
    2. Insira o Nome Modelo de Marketing.
    3. Na lista Projeto, selecione Marketing.
    4. Clique em Criar.
    5. Insira o código para o modelo de nuvem ou use o seguinte código de amostra.

      Observe que as entradas de usuário são para o tamanho e o SO. Você configura variáveis para cada entrada nas propriedades de variação (${input.size}) e imagem (${input.OS}) da máquina. Por fim, a propriedade Nome é usada para construir o nome do recurso (${input.OS}-${input.size}) que pode ser usado no modelo de nomenclatura personalizado.

      formatVersion: 1
      inputs:
        size:
          type: string
          enum:
            - small
            - medium
        OS:
          type: string
          enum:
            - centos
            - ubuntu
      resources:
        Cloud_vSphere_Network_1:
          type: Cloud.vSphere.Network
          properties:
            networkType: existing
        Cloud_Machine_1:
          type: Cloud.Machine
          properties:
            image: ${input.OS}
            flavor: ${input.size}
            name: ${input.OS}-${input.size}
            networks:
              - network: ${resource.Cloud_vSphere_Network_1.id}
      
    6. Para adicionar a propriedade personalizada site.siteCode como uma entrada do usuário, clique na guia Entradas no painel direito e configure as seguintes opções.
      Opção Valor
      Nome mktSite
      Nome de Exibição Selecione um site
      Tipo Objeto
      Selecionar Tipo de Objeto Grupos de propriedades
      Selecionar a partir de grupos de propriedades existentes site
    7. Na guia Código, observe que a entrada do usuário mktSite foi adicionada e atualize o YAML para incluir a propriedade personalizada.

      Por exemplo, adicione site.siteCode: ${input.mktSite.siteCode} ao YAML.

      formatVersion: 1
      inputs:
        size:
          type: string
          title: Select the machine size
          enum:
            - small
            - medium
        OS:
          type: string
          title: Select an operating system
          enum:
            - centos
            - ubuntu
        mktSite:
          type: object
          $ref: /ref/property-groups/site
          title: Select a site
      resources:
        Cloud_vSphere_Network_1:
          type: Cloud.vSphere.Network
          properties:
            networkType: existing
        Cloud_Machine_1:
          type: Cloud.Machine
          properties:
            image: ${input.OS}
            flavor: ${input.size}
            name: ${input.OS}-${input.size}
            networks:
              - network: ${resource.Cloud_vSphere_Network_1.id}
            site.siteCode: ${input.mktSite.siteCode}
  4. Implante o modelo e verifique o nome de máquina personalizado.

    Como West é o valor padrão, selecione um site diferente de West.


    Os detalhes da implantação cloud_machine mostrando o nome do recurso como East-centos-small-000011.

Precedência na nomenclatura de recurso no momento da implantação

Com base na forma como você configura a nomenclatura personalizada, os nomes são aplicados aos recursos implantados com base nas regras a seguir.

Uma prática comum é definir um modelo de nomenclatura geral em nível de organização e, em seguida, criar um ou mais modelos em nível de projeto, dependendo das suas necessidades de gerenciamento de projeto.

Cenário de Nomenclatura Personalizada Precedência
Nenhum nome personalizado
  • O sistema cria os nomes de recursos de implantação para todos os componentes de implantação.
Nome no nível da organização
  • Aplica os valores de propriedade de nomenclatura personalizados e as cadeias de caracteres a todas as implantações.
  • Se o projeto de implantação tiver um nome personalizado no nível do projeto, o nome no nível da organização será substituído.
  • Se um nome personalizado no nível da organização não estiver definido, o nome em nível de projeto será usado para projetos atribuídos.
  • Se não foi definido um nome personalizado no nível da organização nem no nível do projeto, o sistema cria os nomes dos recursos.
Nomes em nível de projeto
  • Aplica os valores de propriedade de nomenclatura personalizada no nível do projeto e as cadeias de caracteres a todos os projetos atribuídos.
  • Se um nome em nível de organização existir, o nome em nível de projeto terá precedência sobre o nome da organização.
  • Se um nome personalizado no nível da organização não estiver definido, o nome em nível de projeto será usado para projetos atribuídos.
  • Se não foi definido um nome personalizado no nível da organização nem no nível do projeto, o sistema cria os nomes dos recursos.

Trabalhando com formatos de modelo

Ao definir o formato do modelo, você pode usar cadeias de caracteres e propriedades. A principal vantagem de usar propriedades é que você pode usar as mesmas propriedades que o formato para vários projetos, mas o nome é derivado das propriedades de valor, que podem variar por projeto, modelo de nuvem, plataforma e outras propriedades.

As propriedades de formato do modelo incluem as propriedades fornecidas, discutidas aqui, e quaisquer propriedades personalizadas que você definiu em Projetar > Grupos de Propriedades.

  • Caracteres válidos
    • Não são permitidos espaços.
    • Para legibilidade, você pode usar caracteres especiais para separar propriedades. Os caracteres permitidos são _ (sublinhado) e - (traço).
  • Propriedades fornecidas
    Tabela 2. Propriedades Fornecidas
    Propriedades Descrição
    endpoint

    Informações da conta de nuvem, como descrição, digite (AWS) ou o nome. O endpoint é aplicado somente a máquinas.

    Exemplos

    • ${endpoint.desc}
    • ${endpoint.endpointType}
    • ${endpoint.name}
    projeto

    Informação do projeto.

    Exemplo

    • ${project.desc}
    • ${project.name}
    recurso

    Inclui o nome do recurso do modelo de nuvem, as propriedades personalizadas que estão no modelo de nuvem ou o projeto.

    Exemplo

    • ${resource.name}
    carimbo de data/hora

    Data e hora da implantação. O valor numérico é aaaa mm dd hh mm ss, mas sem os espaços. Por exemplo, 20210825120345.

    Exemplo

    • ${timestamp}
    usuário

    Exemplo

    • ${user}
    username

    Exemplo

    • ${userName}
    ######

    Propriedade numerada.

    O comprimento máximo é de 19 dígitos.

    Se você usar dois dígitos, ##, o número máximo antes da numeração recomeçar é 99. Se você usar ###, a numeração será reiniciada após 999.

    Exemplo

    • ${####}.
    Propriedade personalizada

    As propriedades personalizadas devem fazer parte do grupo de propriedades. A propriedade no nome personalizado inclui o nome do grupo de propriedades e a propriedade.

    Exemplo

    • ${propertygroup.property}

Trabalhando com o contador

Em uma instância de nó único do VMware Aria Automation, o contador é incrementado com base nos valores que você define nos seus modelos de nomenclatura personalizados e à medida que eles são aplicados à organização e aos projetos de destino.

Em um ambiente de vários nós, o contador tenta incrementar com base nos valores do modelo. Se ele encontrar uma contenção, a aplicação do número será tentada três vezes. É possível que uma solicitação possa falhar após a terceira tentativa de resolver a contenção. Nesse caso, você pode ver uma lacuna na numeração.

Você também pode encontrar lacunas na numeração por outros motivos. Por exemplo, você implanta três máquinas virtuais. A segunda máquina falha durante o provisionamento. Os contadores para máquinas virtuais implantadas são vm-01 e vm-03, com vm-02 ausente.

Se você não usar a nomenclatura personalizada, preferindo depender da estratégia de nomenclatura padrão, os pools de valores de contador serão reservados para os nós da seguinte maneira:

  • Nó 1: 1-300
  • Nó 2: 301-600
  • Nó 3: 601-900

Isso significa que, em um ambiente de vários nós, o número pode parecer inesperado. O número depende de qual nó processa a solicitação.

Lista de tipos de recursos aos quais você pode aplicar nomes personalizados

Você pode criar um nome personalizado para apenas um tipo de recurso ou para todos os tipos de recursos. Somente os tipos de recursos com nomes personalizados usam o modelo. Todos os outros recursos usam o modelo padrão.

Por exemplo, se você criar um nome personalizado no nível do projeto apenas para suas máquinas e tiver nomes em nível de organização para todos os outros tipos de recursos, o recurso de máquina assumirá o nome do projeto e todos os outros recursos usarão os nomes da organização.

Tabela 3. Amostra de lista de recursos
Tipos de recursos de nomenclatura personalizados Tipos de recursos de implantação
Máquinas
  • Cloud.Machine
  • Cloud.vSphere.Machine
  • Cloud.AWS.EC2.Instance
  • Cloud.GCP.Machine
  • Cloud.Azure.Machine
Redes
  • Cloud.Network
  • Cloud.vSphere.Network
  • Cloud.NSX.Network
Armazenamento
  • Cloud.Volume
  • Cloud.vSphere.Disk
  • Cloud.AWS.Volume
  • Cloud.GCP.Disk
  • Cloud.Azure.Disk
Balanceadores de carga
  • Cloud.LoadBalancer
  • Cloud.NSX.LoadBalancer
Grupos de Recursos
  • Cloud.Azure.ResourceGroup
Gateways
  • Cloud.NSX.Gateway
NAT
  • Cloud.NSX.NAT
Grupos de segurança
  • Cloud.SecurityGroup
Genérico
  • Recursos que usam o auxiliar de alocação de nomenclatura personalizado

    O auxiliar de alocação de nomenclatura personalizado gera nomes personalizados para seus recursos durante o processo de alocação. O tipo de recurso Genérico abrange todos os recursos possíveis e está vinculado exclusivamente ao auxiliar de alocação de nomenclatura personalizado.

    Para saber mais sobre o tipo de recurso Genérico e o auxiliar de alocação de nomenclatura personalizado, consulte Criar nomes personalizados com o auxiliar de alocação de nomenclatura personalizado.

Excluindo modelos de nome personalizados

A exclusão de um modelo não afeta a nomenclatura de recurso atualmente implantada. No entanto, você não deve excluir um modelo de nome personalizado até verificar o impacto em todos os projetos atribuídos.

Você pode remover um projeto de um modelo de nomenclatura. O modelo continua funcionando para os outros projetos.

Excluindo projetos com nomes personalizados

Se um projeto tiver um modelo de nomenclatura personalizado aplicado, você deverá primeiro remover o projeto do modelo antes de excluir o projeto.