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