Criando componentes com o cliente da linha de comandos

Se o IBM® UrbanCode Deploy não tiver um tipo de configuração de origem para o sistema de construção, você poderá usar o cliente da linha de comandos udclient para gerenciar componentes.

Antes de Iniciar

Para instalar o cliente, consulte Installing the command-line client.

Sobre Esta Tarefa

Ao utilizar o cliente udclient dessa forma, é possível enviar por push novas versões de componentes para o servidor, iniciar processos, incluir links para origens externas e executar muitas outras tarefas no servidor IBM UrbanCode Deploy como parte do processo de construção. Dessa forma, é possível trabalhar com componentes no IBM UrbanCode Deploy sem alterar a tecnologia de construção.

Procedimento

Siga estas etapas gerais para configurar um componente que utiliza o cliente da linha de comandos:

  1. Criar um ou mais componentes no IBM UrbanCode Deploy para representar os componentes da construção. Use os parâmetros a seguir na janela Criar novo componente:
    • No campo Tipo de configuração de origem, selecione Nenhum.
    • Desmarque a caixa de seleção Importar versões automaticamente.
    • Preencha o restante dos campos na janela como de costume.
  2. Nos scripts de construção para seu componente, inclua o código que chama comandos do cliente udclient para criar uma versão de componente e fazer upload dos artefatos para o servidor IBM UrbanCode Deploy. Na maioria dos casos, você usa diversos comandos diferentes para criar a versão. As etapas a seguir mostram exemplos de alguns dos comandos que você pode usar.
    Nota: Esses exemplos utilizam o código em um arquivo de construção do Apache Ant. Especificamente, eles chamam o cliente udclient com o comando Ant <exec>, que chama programas externos. Se você estiver usando uma tecnologia de construção diferente, deverá adaptar os exemplos à sua tecnologia de construção para chamar o cliente udclient.
    1. Use o comando createVersion para criar a nova versão. O código de exemplo a seguir cria uma versão de um componente denominado mycomponent. O nome da versão é configurado como o registro de data e hora da construção. As variáveis ${udclient.weburl}, ${udclient.username} e ${udclient.password} representam a URL do servidor e o nome do usuário e a senha para o servidor.
      <exec executable="/bin/bash" 
        outputproperty="mycomponent.component.output">
      
        <arg value="/opt/udclient/udclient"/>
      
        <arg value="-weburl"/>
        <arg value="${udclient.weburl}"/>
      
        <arg value="-username"/>
        <arg value="${udclient.username}"/>
      
        <arg value="-password"/>
        <arg value="${udclient.password}"/>
      
        <arg value="createVersion"/>
      
        <arg value="-component"/>
        <arg value="mycomponent"/>
      
        <arg value="-name"/>
        <arg value="${buildTimestamp}"/>
      
      </exec>
    2. Use o comando addVersionFiles para fazer upload dos artefatos para a versão do componente. O código de exemplo a seguir faz upload dos arquivos na pasta ${destdir} pasta para a versão:
      <exec executable="/bin/bash">
      
        <arg value="/opt/udclient/udclient"/>
        
        <arg value="-weburl"/>
        <arg value="${udclient.weburl}"/>
        
        <arg value="-username"/>
        <arg value="${udclient.username}"/>
        
        <arg value="-password"/>
        <arg value="${udclient.password}"/>
        
        <arg value="addVersionFiles"/>
        
        <arg value="-component"/>
        <arg value="mycomponent"/>
        
        <arg value="-version"/>
        <arg value="${buildTimestamp}"/>
        
        <arg value="-base"/>
        <arg value="${destdir}"/>
        
      </exec>
    3. Opcional: Inclua os links da versão do componente. Com o comando addVersionLink, é possível incluir links da versão para recursos de construção externos, como a página que mostra informações sobre o resultado da construção. Esses links aparecem na parte superior da página de informações para a versão do componente. A figura a seguir mostra uma versão de componente com um link para a tarefa de construção relacionada e o resultado da construção relacionado no sistema de gerenciamento de código-fonte:
      Uma versão do componente com dois links na seção Links
      Por exemplo, o código a seguir inclui um link para a página de resultados da construção na URL http://build.example.com/projects/mycomponent/${buildResultUUID}:
      <exec executable="/bin/bash">
      
        <arg value="/opt/udclient/udclient"/>
        
        <arg value="-weburl"/>
        <arg value="${udclient.weburl}"/>
        
        <arg value="-username"/>
        <arg value="${udclient.username}"/>
        
        <arg value="-password"/>
        <arg value="${udclient.password}"/>
        
        <arg value="addVersionLink"/>
        
        <arg value="-component"/>
        <arg value="mycomponent"/>
        
        <arg value="-version"/>
        <arg value="${buildTimestamp}"/>
        
        <arg value="-linkName"/>
        <arg value="External build result"/>
        
        <arg value="-link"/>
        <arg value="http://build.example.com/projects/mycomponent/${buildResultUUID}"/>
        
      </exec>

Resultados

Agora, quando você executa uma construção na ferramenta de construção externa, o processo de construção cria uma versão de componente e faz upload dos artefatos da versão para o servidor IBM UrbanCode Deploy. Desse ponto, você pode trabalhar com o componente e a versão no servidor como de costume, como processos em execução com ele.

Você também pode incluir outros comandos no script de construção. Por exemplo, é possível iniciar processos de aplicativos com o comando requestApplicationProcess.


Feedback