seed-service-orchestration-workflows
v1.0.15
Published
A library that provides nestjs services for orchestration workflows
Downloads
4
Readme
Seed Service Orchestration Workflows
This module can be used with the seed-service-core in order to seed workflows in Orchestration Service when the v1/configData:seed
endpoint is called. This service will look through a directory called out by the env variable SEED_FILE_DIR and find any JSON files whose objects have specified domain
as OrchestrationWorkflows. It will use these files to seed workflows in Orchestration Service
OrchestrationWorkflows Seed Files
A seed file mean to seed a Workflow in Orchestration Service should have the following parameters.
domain
: The domain should be listed as "OrchestrationWorkflows".version
: Identifies the version of the file. SeedServices will only seed files that match their expectedVersions.environments
: A list of environments where the seed file should be seeded.organizationIds
: A list of organizations where the seed file should be seeded.workflowMetadata
: AWorkflowMetadataDto
that will be used to create the workflow using thev1/workflow
endpoint in Orchestration Service.overwrite
: A boolean. If true, the workflow will be overwritten with the seed data everytimev1/configData:seed
is called.
Config Service Lookups
Orchestration Workflows Seed Service looks for the following env variables using ConfigService
ORCHESTRATION_SERVICE_UR
L: The url to use to access Orchestration Service.SERVICE_ACCOUNT_USER
: Username for a service account. Will only use this ifORCHESTRATION_SEVICE_ACCOUNT_USER
is undefined.SERVICE_ACCOUNT_PASS
: Password for a service account. Will only use this ifORCHESTRATION_SERVICE_ACCOUNT_PASS
is undefined.ORCHESTRATION_SERVICE_ACCOUNT_USER
: Username for a service account.ORCHESTRATION_SERVICE_ACCOUNT_PASS
: Password for a service account.