[MOD/onboarding] Switch to v3 component spec
[dcaegen2/platform.git] / mod / onboardingapi / ChangeLog.md
1 # Change Log
2
3 All notable changes to this project will be documented in this file.
4
5 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
6 and this project adheres to [Semantic Versioning](http://semver.org/).
7
8 ## [2.13.0] - 2021/09/21
9
10 Changed
11   - [DCAEGEN2-2876] - Support v3 component spec for helm flow support
12
13
14 ## [2.12.5]
15
16 * Fix component-spec-schema bug: Failed validating 'oneOf' in schema['properties']['volumes']['items']
17
18
19 ## [2.12.4]
20
21 * Update component-spec-schema to support: kafka stream subscribes and publishes, config maps as volumes
22
23 ## [2.12.3]
24
25 * Add Python 3.8 support
26 * Use Integration base image
27
28 ## [2.12.1]
29
30 * Run as non-root
31
32 ## [2.12.0]
33
34 * Add HTTP support using Flask/flask-restplus
35 * Add APIs for component (list, show, add, update, status change)
36 * Add APIs for data format (list, show, add, update, status change)
37 * Change the default value for `enforce_image` from true to false
38 * Enhance Docker image creation to generate the dcae-cli configuration at runtime rather than at build time
39 * Fix format_description to handle no description case
40 * Add filtering by name, version for GET /components
41 * Modify server url in start.sh to point to new spec file
42 * Change dcae cli version in start.sh to 2.12.0
43 * Change werkzeug dependency version in setup.py
44
45 ## [2.11.3]
46
47 * Fix Format class definition of "description" to match JSON schema
48
49 ## [2.11.2]
50
51 * Upgrade to use docker 4.x.x from docker-py 1.x.x
52
53 ## [2.11.1]
54
55 * Change to policy reconfiguration functions to pass consul_host as a parameter
56
57 ## [2.11.0]
58
59 * Add Policy Configuration Support.
60 * Update and improve the Help Text that is displayed to the user.
61 * Component Spec schema additions for parameters section (policy, volumes).
62 * Component Spec schema updates to make the following required: (designer_editable, sourced_at_deployment, policy_editable).
63
64 ## [2.10.2]
65
66 * Fix dependency conflict with python-consul
67 * Fix psycopg2 warning by requiring psycopg2-binary
68 * Use Docker client from env when checking images
69
70 ## [2.10.1]
71
72 * Fix DCAEGEN2-402
73
74 ## [2.10.0]
75
76 * Make server url (url to webserver that has static artifacts like json schemas) a configuration parameter
77 * Seeding configuration is no longer a fatal issue
78 * Setup database connection via manual user inputs if seed config not there
79 * Seeding profiles is no longer a fatal issue
80 * Dynamically fetch Docker login credentials from Consul to use to authenticate when creating Docker client.
81 * Make docker login key into a configuration param
82 * Clean up the hard coupling to the user configuration particularly in the discovery module
83
84 ## [2.9.0]
85
86 * Add data format generate command
87 * Fix issue with data router config keys
88
89 ## [2.8.1]
90
91 * Improve error message when inputs map is missing item. Show the specific parameters that are causing issues.
92
93 ## [2.8.0]
94
95 * Enhance to support parameters that are sourced at deployment
96 * Provide new command line arg --inputs-file
97 * Use inputs file to bind values to generated configuration for parameters that have been specified to be `sourced_at_deployment` true.
98
99 ## [2.7.0]
100
101 * Rip out Docker related code and use common python-dockering library
102     - Using 1.2.0 of python-dockering supports Docker exec based health checks
103 * Add support for volumes
104 * Add support for special DNS configuration in Docker containers to enable use of Consul DNS interface
105
106 ## [2.6.0]
107
108 * Use port mappings from component spec when running Docker containers
109
110 ## [2.5.0]
111
112 * Define the data structure for the input dmaap map items for data router that are passed in `--dmaap-file`. Enhance the json schema.
113 * Create the appropriate delivery url
114 * Enhance spec validation for cdap. Throw error when cdap specs have data router subscribes.
115 * Verify container is up in order to construct and to display data router subscriber delivery urls
116
117 ## [2.4.0]
118
119 * Define the data structure for the input dmaap map items that are passed in `--dmaap-file`. Create and use json schema for validation and applying defaults.
120 * Group config keys by `streams_publishes`, `streams_subscribes`, and `services_calls` in generating the application config for both Docker and CDAP
121
122 ## [2.3.2]
123
124 * Fix issue where components with dashes can't be found when running components that depend upon them. This one addressed the issue in the catalog and in the config creation part of discovery.
125 * Fix misleading "missing downstream component" warning that should be an error.
126
127 ## [2.3.1]
128
129 * Fix issue where components with dashes can't be found when running components that depend upon them.
130 EDIT: This one addressed the issue in the catalog
131
132 ## [2.3.0]
133
134 * Enhance the `component dev` command to print all the environment variables needed to work with the platform for development
135 * Display the component type in the `catalog list` view
136
137 ## [2.2.0]
138
139 * Add fields `cli_version` and `schema_path` to both the components and data formats tables to be used as metadata which can be used for debugging.
140
141 ## [2.1.0]
142
143 * (Re)Initialize both config and profiles by first grabbing files from Nexus
144 * Change `--reinit` to be eager and to be used to reinit config and profiles
145 * Remove *default* profile
146 * Replace the use of backports.tempfile with a combo of pytest `tmpdir` and `monkeypatch`
147
148 ## [2.0.0]
149
150 * Update sqlalchemy and catalog to support postgres and remove mysql support. Still compatible with sqlite.
151 * Add the `catalog` command used to tap into the shared catalog
152 * Change the `component` and the `data_format` command to be for the particular user of the dcae-cli
153 * Changes to support component spec v3: folding of the auxiliary specs into the component spec and adding of the property artifacts
154 * Add the ability to publish components and data formats
155
156 ## [1.6.0]
157
158 * Enhance `component run` to take in dmaap json using the `--dmaap-file` option. This is used to generate configuration that will provide client-side dmaap configuration.
159
160 ## [1.5.0]
161
162 * Enhance `component dev` to take in dmaap json using the `--dmaap-file` option. This is used to generate configuration that will provide client-side dmaap configuration.
163 * Make json schema remote file paths configurable.
164
165 ## [1.4.0]
166
167 * Enhance component list view to show running instances. The standard view shows number of deployments associated with a component and an expanded view that show details of those deployments.
168
169 ## [1.3.0]
170
171 * Fix queries to find unhealthy and defective instances to force dashes to be dots to ensure proper matching
172
173 ## [1.2.0]
174
175 * Expand the undeploy command to include undeploying defective instances
176 * Remove suffix from name to fix mis-naming
177
178 ## [0.12.0]
179
180 * Go back to setting of uid, expose setting of db url
181 * Add ability to *reinit* configuration via `--reinit`
182
183 ## [0.11.0]
184
185 * Make CDAP Parameters follow parameters definitions