fink.code configuration 1.0.1¶
Description¶
Documentation of the config file format for code (a fink tool). Note: if you want to add to the documentation please edit the openapi_code.yaml file
Data Structures¶
code - structure¶
The code config is organized into the following structure:
Name | Required | Type | Format | Properties | Description |
---|---|---|---|---|---|
bundling | No | bundling | configure details regarding bundle artifact | ||
codedeploy | Yes | codedeploy | configure codedeploy details | ||
defaults | Yes | defaults | finetune fink tool lifecycle (override at own risk) |
codedeploy - structure¶
The codedeploy section.
Name | Required | Type | Format | Properties | Description |
---|---|---|---|---|---|
applicationName | Yes | string | |||
artifactsBucket | No | string | s3 bucket name used to upload the artifact bundle | ||
deploymentConfigName | Yes | string | |||
deploymentGroupName | Yes | string |
bundling - structure¶
Configuration specific to the bundling phase.
Name | Required | Type | Format | Properties | Description |
---|---|---|---|---|---|
folders | Yes | array of foldersItem | an array of folder items | ||
zip | No | string | {‘default’: ‘bundle.zip’} | filename for the artifact bundle (e.g. bundle.zip) |
defaults - structure¶
Default properties to finetune fink tool lifecycle (override at own risk).
Name | Required | Type | Format | Properties | Description |
---|---|---|---|---|---|
log_group | Yes | string | {‘default’: ‘/var/log/messages’} | finklabs specific configuration from baseami. | |
settings_file | Yes | string | {‘default’: ‘settings.json’} | validate the tool configuration against openapi spec. | |
stack_output_file | Yes | string | {‘default’: ‘stack_output.yml’} | validate the tool configuration against openapi spec. | |
validate | Yes | boolean | {‘default’: True} | use this if you need to switch off config validation. |
foldersItem - structure¶
Name | Required | Type | Format | Properties | Description |
---|---|---|---|---|---|
source | Yes | string | |||
target | No | string |