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