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