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