External module "internal/machine/configureSdm"

Index

Interfaces

ConfigureOptions

Type aliases

SoftwareDeliveryMachineMaker

Functions

Type aliases

SoftwareDeliveryMachineMaker

SoftwareDeliveryMachineMaker: function

Type that can create a fully configured SDM

Type declaration

- (configuration: LocalSoftwareDeliveryMachineConfiguration): SoftwareDeliveryMachine | Promise<SoftwareDeliveryMachine>
- Parameters
  - configuration: LocalSoftwareDeliveryMachineConfiguration
  Returns SoftwareDeliveryMachine | Promise<SoftwareDeliveryMachine>

Functions

attemptToRequire

attemptToRequire<T>(module: string, failOnError: boolean): T | null

- Defined in internal/machine/configureSdm.ts:247
Attempt to NPM require module

Type parameters
- T
Parameters
- module: string
- failOnError: boolean
Returns T | null

configureGoalSigning

configureGoalSigning(mergedConfig: SoftwareDeliveryMachineConfiguration): void

- Defined in internal/machine/configureSdm.ts:190
Configure SDM to sign and verify goals

Parameters
- mergedConfig: SoftwareDeliveryMachineConfiguration
Returns void

configureJobLaunching

configureJobLaunching(mergedConfig: SoftwareDeliveryMachineConfiguration, machine: SoftwareDeliveryMachine): Promise<void>

- Defined in internal/machine/configureSdm.ts:122
Configure how this SDM is going to handle goals

Parameters
- mergedConfig: SoftwareDeliveryMachineConfiguration
- machine: SoftwareDeliveryMachine
Returns Promise<void>

configureSdm

configureSdm(machineMaker: SoftwareDeliveryMachineMaker, options?: ConfigureOptions): ConfigurationPostProcessor<LocalSoftwareDeliveryMachineConfiguration>

- Defined in internal/machine/configureSdm.ts:73
Configure and set up a Software Delivery Machine instance with the automation-client framework for standalone or single goal based execution

Parameters
- machineMaker: SoftwareDeliveryMachineMaker
- Default value options: ConfigureOptions = {}
Returns ConfigurationPostProcessor<LocalSoftwareDeliveryMachineConfiguration>

configureSdmToRunExactlyOneGoal

configureSdmToRunExactlyOneGoal(mergedConfig: SoftwareDeliveryMachineConfiguration, sdm: SoftwareDeliveryMachine): void

- Defined in internal/machine/configureSdm.ts:154
Configure SDM to run only one goal

Parameters
- mergedConfig: SoftwareDeliveryMachineConfiguration
- sdm: SoftwareDeliveryMachine
Returns void

doWithSdmLocal

doWithSdmLocal<R>(callback: function): Promise<R | undefined>

- Defined in internal/machine/configureSdm.ts:227
Perform the given operation with the sdm-local module if it's available. If it isn't, silently continue without error.

Type parameters
- R
Parameters
- callback: function
  - - (sdmLocal: any): any
    - Parameters
      - sdmLocal: any
      Returns any
Returns Promise<R | undefined>

registerMetadata

registerMetadata(config: Configuration, machine: SoftwareDeliveryMachine): Promise<void>

- Defined in internal/machine/configureSdm.ts:197
Parameters
- config: Configuration
- machine: SoftwareDeliveryMachine
Returns Promise<void>

Generated using TypeDoc