Como criar o pacote de implantação

Nesta página, descrevemos as etapas para criar um pacote de implantação para seu produto de máquina virtual (VM). É preciso criar e enviar o pacote de implantação para publicar seu produto no Google Cloud Marketplace.

Uma implantação é um conjunto de recursos criados e gerenciados em conjunto, como os recursos necessários para seu produto. Um pacote de implantação é especificação de um conjunto de recursos que normalmente são implantados juntos, o que simplifica o processo de implantação desse produto em particular.

Neste guia, você usará o Deployment Manager para criar seu pacote de implantação. Com o Deployment Manager, você cria pacotes de implantação para seus produtos de VM usando arquivos de configuração YAML, JSON ou ProtoText simples.

Determinar como criar o pacote de implantação

Portal do Produtor

Recomendamos que você use a opção de configuração guiada do Portal do Produtor para criar seu pacote de implantação diretamente no Console do Google Cloud.

A configuração guiada é compatível com produtos de VM simples, como implantações de VM única com regras básicas de firewall, mas não com alguns recursos complexos, como implantações com várias VMs e campos de configuração personalizados. Se você precisar de recursos não compatíveis com a configuração guiada, use a ferramenta mpdev de código aberto para criar seu pacote de implantação ou personalizar um pacote atual ao adicionar outros recursos a ele.

Alternar entre a configuração guiada e a configuração manual

Se você usar a opção de configuração guiada do Portal do Produtor e depois quiser mudar para a configuração manual do seu pacote de implantação, clique em ACESSAR CONFIGURAÇÃO MANUAL para alternar para a configuração manual.

Ao mudar, você pode fazer o download da especificação do Autogen para o pacote de implantação criado na configuração guiada, que será usada como base para a configuração manual.

Portal do parceiro

Se o produto for uma implantação simples de uma única instância de VM com regras de firewall básicas, crie um pacote de implantação simples diretamente no Console do Google Cloud.

Se o produto for uma implantação complexa, use a ferramenta mpdev de código aberto para criar e personalizar o pacote de implantação com recursos adicionais.

Veja na tabela a seguir as diferenças entre implantações simples e complexas:

Deployment Descrição Como criar o pacote
Simples Instância de VM única com regras básicas de firewall. Console do Google Cloud
Complexo Implantação complexa, única ou de várias VMs. A implantação pode exigir qualquer um dos seguintes recursos:
  • verificações de cota para CPUs e GPUs, para que os usuários não consigam implantar seu produto se excederem os requisitos de cota;
  • atualizações dinâmicas de preços na página do Deployment Manager;
  • suporte para nuvens privadas virtuais (VPCs) compartilhadas;
  • compatibilidade com VMs com várias placas de rede;
  • capacidade de impedir que os usuários escolham tipos de máquina, GPUs ou sub-redes não disponíveis na zona escolhida.
Ferramenta mpdev

Se você não tiver certeza sobre qual opção de implantação é melhor para seu produto, entre em contato com o Google Partner Engineer para receber orientações.

Antes de começar

  1. Certifique-se de que sua implantação não use o Terraform ou tenha dependências no Terraform.

  2. Se você estiver usando a ferramenta mpdev para criar seu pacote de implantação, siga estas etapas:

    1. Instale a ferramenta mpdev seguindo as instruções no repositório marketplace-tools.
    2. Faça o download do SDK do Google Cloud.

Criar e enviar seu pacote de implantação

A seção a seguir explica como criar o pacote de implantação e enviá-lo ao Google para revisão.

Crie o pacote de implantação usando um dos seguintes métodos:

Criar um pacote de implantação usando o Console do Google Cloud

Para criar e enviar um pacote de implantação simples usando o Console do Google Cloud:

Portal do Produtor

  1. No Portal do Produtor, acesse a seção Pacote de implantação.

  2. Selecione Configuração guiada para soluções simples e clique em CONTINUAR.

  3. Na seção Configurar especificação do Autogen, ao lado do campo de entrada chamado bucket do Cloud Storage, clique em BROWSE.

    Se você já tiver criado um bucket do Cloud Storage, selecione-o aqui.

    Se você não tiver um bucket do Cloud Storage, clique no ícone rotulado Criar novo bucket. Após criar um novo bucket, siga estas etapas:

    • Selecione um nome para o bucket.
    • Especifique em qual região ou regiões o bucket armazena dados.
    • Especifique a classe de armazenamento dos seus dados.
    • Determine o nível de granularidade a ser aplicado às permissões de gerenciamento de identidade e acesso (IAM) para os dados do bucket.
    • Defina configurações avançadas opcionais, como criptografia ou políticas de retenção de dados.
  4. Verifique se o Controle de versão do objeto está ativado no bucket do Cloud Storage.

  5. Para salvar as configurações do bucket e começar a configurar o pacote de implantação, clique em CONFIGURAR.

  6. Em Escolha a imagem do seu produto, selecione sua imagem da VM.

    A imagem de VM selecionada precisa ser:

    • Associados ao seu projeto atual do Google Cloud.

    • Anexado à licença correta do seu produto. Crie e anexe essa licença depois de criar a imagem da VM.

  7. Abaixo de Escolher o tipo de máquina, você precisa especificar uma zona padrão, Tipo de máquina mínimo e Tipo de máquina padrão para seu produto de VM, além do tamanho e do tipo do disco de inicialização dele.

  8. Em Especificar sistema operacional, você precisa especificar o nome e a versão do sistema operacional que sua imagem de VM usa, bem como o número da versão da imagem da VM.

  9. Como alternativa, em Configurar acesso à VM, especifique os URLs do site e do administrador, além do nome de usuário e da senha, que os usuários poderão usar para acessar a VM após a implantação.

  10. Outra opção é, em Configurar rede, especificar as configurações de Encaminhamento de IP e configurar as regras de Firewall.

  11. Também é possível, na opção Definir próximas etapas fornecer instruções aos usuários para orientá-los sobre como começar a usar seu produto. Essas instruções ficarão visíveis após a implantação do produto.

  12. Depois de concluir as etapas anteriores, clique em GERAR para criar o pacote de implantação.

    Se precisar fazer alterações adicionais no pacote de implantação mais tarde, clique em EDITAR para fazer alterações e em GERAR para gerar novamente o pacote de implantação com as alterações aplicadas.

    Se você planeja mudar para a configuração manual, clique em FAZER DOWNLOAD para fazer o download da especificação do Autogen para o pacote de implantação que você criou na configuração guiada: usar como base para sua configuração manual.

  13. Envie o pacote de implantação para revisão no Portal do Produtor. Depois de enviar o pacote, pode levar até duas semanas para o Google analisar e aprovar o pacote.

Portal do parceiro

  1. Acesse o Portal do Parceiro e selecione seu produto na lista.
  2. Ao lado de Pacote de implantação, clique em Editar.
  3. Selecione a opção para Gerar um pacote e clique em Continuar.
  4. Selecione sua imagem de VM usando os menus suspensos Projeto e Imagem e clique em Continuar.
  5. Selecione suas configurações de Tipo de máquina mínimo e Tipo de máquina padrão e clique em Continuar.
  6. Adicione as próximas etapas de pós-implantação que seus clientes devem seguir e clique em Continuar.
  7. Configure suas Regras de firewall e outras opções de rede, se for o caso, e clique em Continuar.
  8. É possível declarar um site ou URL de administrador. Se seu produto exigir login, configure os detalhes de login ao enviar sua solução. Clique em Continue.
  9. Em Listar o conteúdo do pacote, selecione o Nome do sistema operacional e a Versão do SO referentes ao sistema operacional da imagem de VM. É possível adicionar um Nome e uma Versão para cada software extra incluído como parte da seu produto. Depois de listar todo o conteúdo do pacote, clique em Continuar.
  10. Depois de concluir as etapas anteriores, o pacote de soluções será exibido em Revisar. É possível fazer o download do pacote da solução ou clicar em Editar JSON para modificá-lo manualmente. Clique em Salvar para salvar o pacote e retornar à sua solução.

Crie um pacote de implantação usando mpdev.

Nesta seção, explicamos como usar a ferramenta mpdev para criar um pacote de implantação e enviá-lo para revisão.

A ferramenta mpdev usa o Autogen do Deployment Manager para gerar os modelos do Deployment Manager para o pacote de implantação. A ferramenta gera o pacote de implantação com base em uma especificação do Autogen que contém as entradas de configuração para seu produto de VM.

Para criar seu pacote de implantação usando mpdev, use as instruções a seguir se você usar o Portal do Produtor ou o Portal do Parceiro para integrar seu produto ao Google Cloud Marketplace:

Portal do Produtor

Em geral, para gerar e enviar seu pacote de implantação, é necessário fazer o seguinte:

  1. Crie e configure um bucket do Cloud Storage para armazenar e gerenciar o acesso ao pacote de implantação.
  2. Crie uma especificação do Autogen que inclua os detalhes da imagem e os requisitos de implantação do produto da VM.
  3. Gere o pacote de implantação com base na especificação do Autogen e faça upload do pacote para o bucket do Cloud Storage.
  4. Envie o pacote de implantação para revisão no Portal do Produtor. Depois do envio, pode levar até duas semanas para o Google analisar e aprovar o pacote.

As seções a seguir explicam como concluir as etapas para gerar e enviar o pacote de implantação.

Crie o bucket do Cloud Storage

Crie o bucket do Cloud Storage no mesmo projeto público do Google Cloud usado para o Portal do Produtor e configure o bucket das seguintes maneiras:

Para criar e configurar um bucket do Cloud Storage, execute os seguintes comandos gsutil:

BUCKET_NAME=YOUR_BUCKET_NAME
gsutil mb $BUCKET_NAME
gsutil versioning set on gs://$BUCKET_NAME
gsutil iam ch "group:cloud-commerce-marketplace-onboarding@twosync-src.google.com:objectViewer" $BUCKET_NAME

Em que YOUR_BUCKET_NAME é o nome que você fornece para o novo bucket, sujeito a requisitos de nomenclatura.

Criar sua especificação do Autogen

Para criar sua especificação do Autogen, recomendamos que você use o single VM example no repositório marketplace-tools como sua especificação inicial do Autogen e, em seguida, personalize a especificação com o detalhes de configuração.

Em casos de uso mais complexos, é possível configurar o preenchimento automático em alguns ambientes de desenvolvimento integrados (IDEs) para ajudar a editar e validar arquivos configurations.yaml.

Para criar sua especificação do Autogen no single VM example:

  1. Confira a especificação do Autogen pré-configurada do exemplo para um diretório local:
 PACKAGE=YOUR_PACKAGE_NAME
 mpdev pkg get https://github.com/GoogleCloudPlatform/marketplace-tools.git/examples/deployment-manager/autogen/singlevm $PACKAGE

Em que YOUR_PACKAGE_NAME é o nome que você fornece para o diretório local. Por exemplo, my-deployment-package.

  1. Atualize a especificação com os detalhes de configuração da VM modificando o arquivo configurations.yaml com as seguintes informações:

    • O nome da imagem da VM.
    • O ID do projeto público do Google Cloud que hospeda a imagem de VM, que é o mesmo projeto que você usa no Portal do Produtor.

    Para seguir as etapas de atualização da imagem da VM e dos campos do projeto do Google Cloud no arquivo configurations.yaml, consulte o arquivo README.md da single VM example.

  2. Se necessário para seu produto, personalize outros campos, como passwords, deployInput e postDeploy. Esses campos estão localizados abaixo de DeploymentSpec no arquivo configurations.yaml. Para saber mais sobre os campos disponíveis para personalização, consulte a documentação de referência do Autogen.

Gerar seu pacote de implantação

Depois de criar e personalizar a especificação do Autogen, use a especificação para gerar os arquivos de modelo do Deployment Manager para o pacote de implantação. Para armazenar o pacote, faça upload dele para o bucket do Cloud Storage.

Para gerar e fazer upload do pacote de implantação:

  1. Defina o local de saída do pacote de implantação no bucket do Cloud Storage:

    mpdev cfg set zipPath gs://BUCKET_NAME/OBJECT
    

    Em que BUCKET_NAME é o nome do bucket que você criou para o pacote e OBJECT é o nome que você fornece para o objeto do Cloud Storage, sujeito às diretrizes de nomenclatura.

  2. Gere o pacote de implantação:

    mpdev apply -f $PACKAGE/configurations.yaml
    

O pacote de implantação gerado é compactado e enviado ao seu bucket.

Para verificar se o modelo está configurado corretamente, execute o comando a seguir para criar uma implantação:

TMPDIR=$(mktemp -d)
unzip $PACKAGE/template.zip -d $TMPDIR
gcloud deployment-manager deployments create $PACKAGE --config $TMPDIR/test_config.yaml

Portal do parceiro

Criar sua especificação do Autogen

Recomendamos que você crie sua especificação inicial do Autogen usando single VM example no repositório marketplace-tools. Para criar sua especificação do single VM example, execute o seguinte comando:

mpdev pkg get https://github.com/GoogleCloudPlatform/marketplace-tools.git/examples/deployment-manager/autogen/singlevm MY_PACKAGE

Siga as próximas etapas descritas no arquivo README.md do exemplo baixado. Essas etapas incluem a edição de campos do arquivo configurations.yaml específicos da sua solução. Depois de concluir essas etapas, execute mpdev apply na configuração mpdev editada para gerar o pacote do Deployment Manager.

Para ver a documentação detalhada dos campos em DeploymentSpec no configurations.yaml, consulte a documentação de referência do Autogen.

Também é possível ver outras configurações de amostra na pasta examples.

Criar credenciais de autorização

Você pode especificar vários passwords em DeploymentSpecem configurations.yaml. É possível recuperar senhas do servidor de metadados de instância e visualizá-las na interface de pós-implantação.

Gerar seu pacote de implantação

Veja a seguir um exemplo de comando que lê a especificação em MY_PACKAGE/configurations.yaml e gera um arquivo ZIP para o local especificado em MY_PACKAGE/configurations.yaml:

mpdev apply -f MY_PACKAGE/configurations.yaml

Depois que o pacote de implantação for criado, siga estas instruções para fazer o upload do pacote de implantação para o Portal do Parceiro.

Enviar seu pacote de implantação para revisão no Portal do Produtor

Se você estiver usando o Portal do Produtor para criar a listagem de produtos do Google Cloud Marketplace, depois de criar seu pacote de implantação, será necessário enviar o pacote ao Portal do Produtor para que a equipe do Google Cloud Marketplace possa analisar e aprovar o pacote.

Para enviar seu pacote de implantação para revisão, faça o seguinte:

Configuração guiada

  1. No Portal do Produtor, acesse a seção Pacote de implantação.

  2. Clique em ENVIAR para enviar o pacote de implantação para revisão no Portal do Produtor. Depois do envio, pode levar até duas semanas para que o Google analise e aprove o pacote.

Configuração manual

  1. Abra o Portal do Produtor no Console do Google Cloud:

    https://console.cloud.google.com/producer-portal?project=YOUR_PUBLIC_PROJECT_ID
    

    Substitua YOUR_PUBLIC_PROJECT_ID pelo ID do projeto público que você criou para o Google Cloud Marketplace, por exemplo, my-organization-public.

  2. Na lista de produtos, clique no nome do seu produto.

  3. Na página Visão geral do produto, vá para a seção Pacote de implantação e clique em EDITAR.

  4. Em Especificar o local do objeto do GCS, selecione o objeto do pacote de implantação que você enviou anteriormente.

  5. Clique em VALIDAR. O processo de validação pode levar até duas horas para ser concluído, e você pode sair da tela enquanto ela é concluída.

  6. Depois que o Portal do Produtor ler o pacote de implantação, clique em VISUALIZAÇÃO DA IMPLANTAÇÃO para ver como o cliente visualiza sua configuração de VM.

  7. Depois que a validação for concluída, clique em ENVIAR para enviar o pacote de implantação para revisão. Depois do envio, pode levar até duas semanas para que o Google revise e aprove o pacote.

Pacotes de implantação na visão do cliente

Nas seções a seguir, mostramos os layouts de tela que seus clientes veem quando implantam seu produto, no caso de produtos baseadas em pacotes de solução padrão gerados automaticamente.

Visão do cliente sobre a implantação de um pacote

Os elementos de entrada padrão do cliente são mostrados no lado esquerdo da captura de tela a seguir e incluem a zona, o tipo de máquina, as opções de disco e as opções de rede.

Se a implantação de um cliente exigir várias placas de rede, ele poderá adicionar outras interfaces de rede clicando em Adicionar interface de rede.

Para implantar sua solução, seus clientes precisam preencher os campos de entrada e clicar em Implantar.

Visão do cliente sobre um pacote implantado

A imagem a seguir mostra como seu produto é exibido para os clientes depois da implantação.

Os elementos de saída padrão são mostrados no lado direito da captura de tela a seguir. Eles incluem o endereço do site, a senha temporária do administrador e informações sobre a instância.