Esquema de definição de fluxo de trabalho

Esquema

As definições de fluxo de trabalho são escritas em YAML. As chaves usam a convenção de nomenclatura camelCase.

Propriedades do esquema

entradas de fluxo de trabalho

Exemplo:

workflowInputs:
  myInput1:
    type: String
  myInput2:
    type: Number
    defaultValue: 42

• workflowInputs.<inputName> (Obrigatório)

  • Tipo: String (em conformidade com o padrão de segurança de expressão)
  • Comprimento mínimo: 1
  • Comprimento máximo: 50
  • Descrição: O nome da entrada do fluxo de trabalho.

• workflowInputs.<inputName>.type (Obrigatório)

  • Tipo: Enum (Boolean, List, Map, String, Int, Float)
  • Descrição: O tipo de dados da entrada do fluxo de trabalho.

• workflowInputs.<inputName>.defaultValue (Opcional)

  • Tipo: Qualquer; deve estar em conformidade com type.
  • Descrição: O valor padrão para a entrada do fluxo de trabalho.

• workflowInputs.<inputName>.required (Opcional)

  • Tipo: Booleano (True, False).
  • Descrição: O valor padrão deste campo é "Verdadeiro".

• workflowInputs.<inputName>.enumValues (Opcional)

  • Tipo: Lista (String).
  • Descrição: O valor padrão deste campo é uma lista vazia {}. Isso é necessário quando o tipo workflowInput é Enum.

• workflowInputs.<inputName>.validations (Opcional)

  • Tipo: matriz de mapas.
  • Descrição: Validações a serem realizadas nas entradas do fluxo de trabalho fornecidas pelo usuário. Este campo é opcional. As propriedades descritas aqui estão presentes em todos os tipos de validação. Os Tipos de Validação Específicos suportam propriedades adicionais, conforme discutido na seção Tipos de Validação.

• validations[*].type (Obrigatório)

  • Tipo: String
  • Descrição: O tipo de validação que indica qual validação ocorrerá neste campo. Consulte Tipos de Validação para obter mais informações sobre cada tipo de validação.

• validations[*].errorMessage (Obrigatório)

  • Tipo: String
  • Descrição: A mensagem de erro que o usuário deseja receber quando uma validação específica falhar.

Exemplo de YAML para validações

name: calendar_demo

  workflowInputs:
    timezone:
      type: String
      defaultValue: 'America/Los_Angeles'
      validations:
        - type: regex
          errorMessage: "The provided timezone is not correct"
          pattern: "^[A-Za-z]+\/[A-Za-z_]+(?:\/[A-Za-z_]+)?$"

        - type: maxLength
          errorMessage: "Timezone length should be less than 100"
          length: 100

    accountId:
      type: Int
      validations:
        - type: minIntValue
          errorMessage: "Account id should be greater than 100000"
          minValue: 100000
        - type: maxIntValue
          errorMessage: "Account id should be less than 9999999"
          maxValue: 9999999

  steps:
    - name: getCurrentTime
      type: action
      action: http.get
      version: 1
      inputs:
        url: 'https://worldtimeapi.org/api/timezone/${{ .workflowInputs.timezone }}'
        selectors:
          - name: timezone
            expression: '.responseBody | fromjson.abbreviation'
          - name: datetime
            expression: '.responseBody | fromjson.datetime'

Passos

Propriedades comuns dos degraus

Tipos de etapas

Ação

Uma etapa que executa uma ação específica. Consulte o catálogo de ações para ver as opções disponíveis.

• steps[*].action (Obrigatório)

  • Tipo: String
  • Descrição: O nome completo da função de ação a ser executada. Deve seguir a seguinte convenção: <company domain>.<category of work>.<action name in camelCase>

Exemplo:

• Ação utilizando os serviços do New Relic (por exemplo, através do NerdGraph): newrelic.dashboards.getDashboard

• Ação usando o Slack: slack.chat.postMessage

• steps[*].version (Obrigatório)

  • Tipo: String
  • Descrição: A versão da função de ação a ser executada.

• steps[*].inputs (Opcional)

  • Tipo: Mapa de valores (inclui expressões)

  • Descrição:

    • Os parâmetros a serem passados para a função de ação. As entradas específicas aceitas são definidas por cada ação.
    • As entradas podem usar expressões. Consulte a seção Cadeias de Expressão para obter detalhes.

  Importante

  Não devem ser passados dados sensíveis (nenhuma chave de API ou segredos, nenhum dado PII, PHI ou qualquer dado de identificação pessoal) como argumentos.

• steps[*].inputs.selectors (Opcional)

  • Tipo: lista de mapas no formato name com expression.

  • Descrição:

    • A entrada selectors permite redefinir a saída para retornar apenas os elementos especificados.
    • Podem ser utilizadas expressões. Consulte a seção Cadeias de expressão para obter detalhes.

Exemplo:

• No exemplo dado, estamos recebendo timezone e datetime como resposta da ação http.get.

name: calendar_demo

  workflowInputs:
    timezone:
      type: String
      defaultValue: 'America/Los_Angeles'
    accountId:
      type: Int

  steps:
    - name: getCurrentTime
      type: action
      action: http.get
      version: 1
      inputs:
        url: 'https://worldtimeapi.org/api/timezone/${{ .workflowInputs.timezone }}'
        selectors:
          - name: timezone
            expression: '.responseBody | fromjson.abbreviation'
          - name: datetime
            expression: '.responseBody | fromjson.datetime'

Laço

Um laço irá iterar sobre uma coleção dada definida por in e criar variáveis de laço index e element para cada uma de suas iterações. Essas variáveis de loop são acessíveis dentro do loop apenas com a expressão ${{ .steps.<loopStepName>.loop.element }} ou ${{ .steps.<loopStepName>.loop.index }

Para obter mais detalhes:

• steps[*].for (Obrigatório)

  • Tipo: Constante
  • Descrição: Sinal de início de um loop

• steps[*].in (Obrigatório)

  • Tipo: string (expressão)

  • Descrição: Uma expressão que precisa ser avaliada como uma coleção de elementos.

  • steps[*].steps (Opcional)

    • Descrição: Etapas a serem executadas em cada iteração do loop. Veja a definição das etapas acima.

Exemplo:

name: myWorkflow
  steps:
    - name: loopStep
      type: loop
      for:
        in: "${{ [range(1; 5)] }}"
        steps:
          - name: step1
            type: action
            action: newrelic.ingest.sendLogs
            version: 1
            inputs:
              logs:
                - message: "Loop: ${{ .steps.loopStep.loop.element }}"

Trocar

• Uma etapa que verifica várias condições e executa o primeiro ramo que resulta em verdadeiro.

• Um switch pode conter qualquer número de condition elementos em uma lista. O sistema verificará as condições em ordem e processará a primeira que for avaliada como verdadeira. Se nenhuma for avaliada como verdadeira, executará sua etapa next conforme definido em steps[*].next.

  • steps[*].switch (Obrigatório)

    • Tipo: matriz
    • Descrição: Uma matriz de casos de alternância, especificando a lista ordenada de condições a serem avaliadas.

  • steps[*].switch[*].condition (Obrigatório)

    • Tipo: String (expressão)
    • Descrição: O estado da caixa do interruptor. Se avaliado como verdadeiro, o passo do caso next será executado.
    • Consulte a seção Cadeias de expressão para obter detalhes.

  • steps[*].switch[*].next (Obrigatório)

    • Tipo: String (em conformidade com o padrão de segurança de expressão)
    • Descrição: O nome da etapa a ser executada se a condição do caso for avaliada como verdadeira. A palavra-chave especial end pode ser usada para indicar que esta etapa deve ser a última a ser executada.

  - name: hasCompleted
      type: switch
      switch:
        - condition: ${{ .steps.waitForCompletion.outputs.automationExecutionStatus == "Failed" }}
          next: displayError
        - condition: ${{ .steps.waitForCompletion.outputs.automationExecutionStatus == "Success" }}
          next: displaySuccess
      next: displayUnexpected

  Copiar

Espere

Uma etapa que pausa a execução do fluxo de trabalho por um número específico de segundos antes de continuar.

A etapa de espera também pode ficar à escuta de um ou mais sinais. Cada sinal deve ter uma próxima etapa correspondente definida em uma lista. Se um sinal for recebido durante o período de espera, o primeiro sinal recebido será processado e o fluxo de trabalho executará a próxima etapa definida. Caso nenhum sinal seja recebido, o fluxo de trabalho continua normalmente após o término do período de espera.

O valor recebido de um sinal é armazenado na saída da etapa de espera e pode ser usado em etapas subsequentes para lógica ou processamento.

Exemplo:

name: waitSignalExample
  workflowInputs:
  steps:
    - name: waitStep
      type: wait
      seconds: 300
      signals: [{name: 'mySignalName', next: 'firstStep'}]
    - name: endStep
      type: action
      action: newrelic.instrumentation.log
      version: 1
      inputs:
        message: "didn't get signal"
      next: end
    - name: firstStep
      type: action
      action: newrelic.instrumentation.log
      version: 1
      inputs:
        message: ${{ .steps.waitStep.outputs.signalInputs.myString }}

• steps[*].seconds (Obrigatório)

  • Tipo: Número
  • Descrição: O número de segundos a aguardar antes de continuar a execução do fluxo de trabalho.

• steps[*].signals

  • Tipo: matriz
  • Descrição: Os sinais que, quando recebidos, irão desviar o fluxo do programa.

• steps[*].signals[*].name

  • Tipo: String
  • Descrição: O nome do sinal a ser monitorado.

• steps[*].signals[*].next

  • Tipo: String
  • Descrição: O passo a ser executado se o sinal especificado for recebido.

Atribuir

Uma etapa que define variáveis para uso em todo o fluxo de trabalho. Esta etapa atribui valores a variáveis que podem ser referenciadas em etapas subsequentes. Ao definir todas as variáveis em um só lugar, esse tipo de etapa torna o fluxo de trabalho mais legível e otimizado.

Exemplo de fluxo de trabalho:

name: sampleWorkflowWithAssign
  description: WorkflowAssignDemo

  workflowInputs:
    initialValue:
      type: String
    anotherValue:
      type: Int

  steps:
    - name: runAction
      type: action
      action: internal.http.post
      version: 1
      inputs:
        url: 'http://localhost:8505/tasks/gc' # temporal-activity-worker-java service port
        selectors:
          - name: statusCode
            expression: '.statusCode'
          - name: responseBody
            expression: '.responseBody'
    - name: variableInitialization
      type: assign
      inputs:
        stringVar: "${{ .workflowInputs.initialValue }}"
        intVar: "${{ .workflowInputs.anotherValue }}"
        concatenationVar: "${{ .workflowInputs.initialValue }} - concatenated"
        booleanVar: true
        mapVar:
          key1: "value1"
          key2: "${{ .workflowInputs.initialValue }}"
        listVar:
          - "listItem1"
          - "${{ .workflowInputs.initialValue }}"
          - "${{ .workflowInputs.anotherValue }}"
        statusCode: ${{ .steps.runAction.outputs.statusCode }}

    - name: wait
      type: wait
      seconds: 2

    - name: logVariables
      type: action
      action: newrelic.ingest.sendLogs
      version: 1
      inputs:
        logs:
          - message: "stringVar: ${{ .steps.variableInitialization.outputs.stringVar }}"
          - message: "intVar: ${{ .steps.variableInitialization.outputs.intVar }}"
          - message: "concatenationVar: ${{ .steps.variableInitialization.outputs.concatenationVar }}"
          - message: "booleanVar: ${{ .steps.variableInitialization.outputs.booleanVar }}"
          - message: "mapVar: ${{ .steps.variableInitialization.outputs.mapVar | tojson }}"
          - message: "listVar: ${{ .steps.variableInitialization.outputs.listVar | tojson }}"
          - message: "statusCode: ${{ .steps.variableInitialization.outputs.statusCode }}"

• steps[*].inputs (Obrigatório)

  • Tipo: Mapa de valores (inclui expressões)
  • Descrição:
    • As entradas consistem em um mapa de nomes de variáveis e seus respectivos valores atribuídos. Quando referências secretas são atribuídas a variáveis, elas permanecem como referências secretas e não são convertidas em seus valores reais. No entanto, outras expressões (como entradas de fluxo de trabalho) são avaliadas e convertidas em seus valores reais.
  • Tipos de entrada permitidos: Integer, Double, Boolean, String, Array, Map

Tipos de validação

Tipos compartilhados

Cadeias de expressões

Diversas propriedades aceitam valores de string com expressões incorporadas que são avaliadas durante a execução do fluxo de trabalho, permitindo valores dinâmicos nas definições do fluxo de trabalho.

As cadeias de expressões podem conter uma ou mais expressões, cada uma delimitada por chaves duplas. O conteúdo entre chaves é avaliado usando jq, que fornece recursos poderosos para acessar e manipular valores.

Exemplo:

Obter o comprimento de uma string de entrada de fluxo de trabalho:

${{ .workflowInputs.myString | length }}

Para validar e testar suas expressões, use o JQ Playground.

Propriedades de expressão

Diversas propriedades podem ser acessadas por meio de expressões. Essas propriedades residem em um objeto scope, portanto, as expressões devem começar com um ponto (.) para acessar essas propriedades do objeto de escopo.

Os imóveis disponíveis são:

• workflowInputs - Objeto contendo as entradas passadas para o fluxo de trabalho no início.

Exemplo:

${{ .workflowInputs.myInput }}

• steps - Objeto contendo uma propriedade para cada etapa do fluxo de trabalho
• steps.<stepName> - Objeto contendo propriedades para uma etapa específica
• steps.<stepName>.outputs - Objeto contendo propriedades de resultado, específicas para a etapa ou ação.

Exemplo: ${{ .steps.myStep.outputs.myResult }}

Resultados da avaliação da expressão

Uma única expressão jq pode resultar em qualquer tipo JSON. No entanto, o resultado final de uma string de expressão depende de a string conter apenas a expressão ou conteúdo adicional.

Expressão única (preserva o tipo JSON):

Se uma string de expressão consistir em apenas uma expressão sem conteúdo circundante, ela será avaliada como o resultado da expressão jq, mantendo seu tipo JSON original. Por exemplo, ${{ .workflowInputs.myArray }} é avaliado como uma matriz. Isso é útil para transmitir estruturas de dados complexas dentro de um fluxo de trabalho.

Expressões múltiplas ou conteúdo misto (converte para string):

Se uma expressão contiver conteúdo que não seja uma única expressão, ela será avaliada como um resultado em formato de string. Isso ocorre quando uma expressão tem conteúdo antes ou depois dela, ou quando a string contém múltiplas expressões. Cada expressão dentro da string é avaliada e convertida em uma representação em string.

Exemplo:

Vamos supor que myArray tenha o valor de [1, 2, 3].

Expressão padrão seguro

As propriedades que podem ser usadas em expressões devem estar em conformidade com: ^[A-Za-z_][A-Za-z0-9_]*$

Referências secretas

Os valores secretos podem ser usados em ações por meio de strings de referência que especificam o nome de um segredo a ser pesquisado no Serviço de Segredos. Para referenciar um segredo em uma definição de fluxo de trabalho, use a seguinte sintaxe:

• ${{ :secrets:<SECRET_NAME> }} para um segredo que não está em um namespace
• ${{ :secrets:<NAMESPACE>:<SECRET_NAME> }} para um segredo em um namespace
• ${{ :secrets:<SCOPE>:<NAMESPACE>:<SECRET_NAME> }} para um segredo no escopo e namespace. O escopo aceita apenas ACCOUNT ou ORGANIZATION por enquanto.

Uma string de expressão pode conter uma mistura de referências secretas e expressões JQ and/or múltiplas referências secretas.

Exemplos:

steps:
  - name: mySecretStep
    type: action
    action: newrelic.instrumentation.log
    inputs:
      message: My message
      licenseKey: ${{ :secrets:<SECRET_NAME> }}

steps:
    - name: bearer_auth
      type: action
      action: utils.http.post
      inputs:
        headers:
          Authorization: Bearer ${{ :secrets:<SECRET_NAME> }}

Exemplos

Demonstração do calendário

Um exemplo completo de fluxo de trabalho que demonstra vários recursos de fluxo de trabalho, incluindo entradas de fluxo de trabalho, ações HTTP, seletores, etapas de espera, consulta NRQL, instruções switch e notificação Slack.

name: calendar_demo

  workflowInputs:
    timezone:
      type: String
      defaultValue: 'America/Los_Angeles'
    accountId:
      type: Int

  steps:
    - name: getCurrentTime
      type: action
      action: http.get
      version: 1
      inputs:
        url: 'https://worldtimeapi.org/api/timezone/${{ .workflowInputs.timezone }}'
        selectors:
          - name: timezone
            expression: '.responseBody | fromjson.abbreviation'
          - name: datetime
            expression: '.responseBody | fromjson.datetime'

    - name: logTime
      type: action
      action: newrelic.instrumentation.log
      version: 1
      inputs:
        message: 'DEMO: In the ${{ .steps.getCurrentTime.outputs.timezone }} timezone, the current time is ${{ .steps.getCurrentTime.outputs.datetime }}'
        licenseKey: ${{ :secrets:STAGING_NEW_RELIC_LICENSE_KEY }}

    - name: wait
      type: wait
      seconds: 1

    - name: queryForLog
      type: action
      action: newrelic.nrql.query
      version: 1
      inputs:
        accountIds: ['${{ .workflowInputs.accountId }}']
        query: FROM Log SELECT * WHERE message LIKE 'DEMO:%${{ .steps.getCurrentTime.outputs.datetime }}'

    - name: checkQuery
      type: switch
      switch:
        - condition: ${{ .steps.queryForLog.outputs.results | length > 0 }}
          next: postResultsMessage

    - name: postWaitingMessage
      type: action
      action: slack.chat.postMessage
      version: 1
      inputs:
        channel: test-channel-workflow
        text: Waiting for log message...
        token: ${{ :secrets:dn_staging_slack_token }}
      next: wait

    - name: postResultsMessage
      type: action
      action: slack.chat.postMessage
      version: 1
      inputs:
        channel: test-channel-workflow
        text: 'Found log message! ${{ .steps.queryForLog.outputs.results[0].message }}'
        token: ${{ :secrets:dn_staging_slack_token }}