<commit_before>Senlin TODO Item List
=====================
This document records all workitems the team want to finish in a short-term
(usually a development cycle which lasts 6 month). All jobs listed here are NOT
in working progress which means developers can pick up any workitem they are
interested in if they do have enough time to work on it. Developer should file
a BluePrint in the launchpad to give a detailed description about their plan after
deciding to work on a specific item. A patch should be proposed as well to remove
related workitem from the TODO list after the BP gets approval.


HIGH PRIORITY
=============

API
---
  - Find and fill gaps with API-WG besides the one we already identified.
  - Validate API request for unexpected attributes. Such attributes should
    result in a 400 error. [https://review.openstack.org/#/c/260292]

DOC
---
  - Add documentation for configuration options, configuration in the project
    oslo.messaging project can be used as an example. E.g. the
    `oslo_config.sphinxext` extension and the `show-options` stanza.

ENGINE
------
  - Scaling Improvments [https://etherpad.openstack.org/p/newton-senlin-ha]
    * Ensure all scaling operations are based on 'desired_capacity'.
    * Ensure 'desired_capacity' will be controlled by users, not senlin engine
      or policies.
    * Always do health check before any scaling actions.

POLICY
------

  - Investigate the impact of node-create and node-delete on certain policies.


MIDDLE PRIORITY
===============

API
---
  - Support advanced filters as suggested by the API WG:
    `Filtering Guidelines`_
  - Support to ``os-request-id`` when serving api requests.
  - Add profile-validate and policy-validate APIs:
    https://etherpad.openstack.org/p/newton-senlin-validation


PROFILE
-------

  - Add support to template_url for heat stack profile. If template and template_url
    are both specified, use template. Need to refer to heat api test for testing heat
    profile.


POLICY
------
  - Provide support for watching all objects we created on behalf of users, like
    loadbalancer which is created when attaching lb policy.
  - Leverage other monitoring service for object health status monitoring.


DB
--
  - Add db purge (senlin-manage) for deleting events and actions because they
    accumulate very fast.


LOW PRIORITY
============

ENGINE
------
  - Allow actions to be paused and resumed. This is important for some background
    actions such as health checking.
  - Add support to replace a cluster node with another node.
  - Provide support to oslo.notification and allow nodes to receive and react
    to those notifications accordingly: `Autoscaling Notifications`_

POLICY
------
  - Batching policy: create batchs for node creation/deletion/update.

PROFILE
-------
  - Support disk property update for os.nova.server profile

Receiver
--------
  - Zaqar queue based receiver.


DOC
-----
  - Provide a sample conf file for customizing senlin options.


.. _`Filtering Guidelines`: http://specs.openstack.org/openstack/api-wg/guidelines/pagination_filter_sort.html#filtering
.. _`Autoscaling Notifications`: https://ask.openstack.org/en/question/46495/heat-autoscaling-adaptation-actions-on-existing-servers/<commit_msg>TODO: Add OSProfiler support<commit_after>Senlin TODO Item List
=====================
This document records all workitems the team want to finish in a short-term
(usually a development cycle which lasts 6 month). All jobs listed here are NOT
in working progress which means developers can pick up any workitem they are
interested in if they do have enough time to work on it. Developer should file
a BluePrint in the launchpad to give a detailed description about their plan after
deciding to work on a specific item. A patch should be proposed as well to remove
related workitem from the TODO list after the BP gets approval.


HIGH PRIORITY
=============

API
---
  - Find and fill gaps with API-WG besides the one we already identified.
  - Validate API request for unexpected attributes. Such attributes should
    result in a 400 error. [https://review.openstack.org/#/c/260292]

DOC
---
  - Add documentation for configuration options, configuration in the project
    oslo.messaging project can be used as an example. E.g. the
    `oslo_config.sphinxext` extension and the `show-options` stanza.

ENGINE
------
  - Scaling Improvments [https://etherpad.openstack.org/p/newton-senlin-ha]
    * Ensure all scaling operations are based on 'desired_capacity'.
    * Ensure 'desired_capacity' will be controlled by users, not senlin engine
      or policies.
    * Always do health check before any scaling actions.

POLICY
------

  - Investigate the impact of node-create and node-delete on certain policies.


MIDDLE PRIORITY
===============

API
---
  - Support advanced filters as suggested by the API WG:
    `Filtering Guidelines`_
  - Support to ``os-request-id`` when serving api requests.
  - Add profile-validate and policy-validate APIs:
    https://etherpad.openstack.org/p/newton-senlin-validation


PROFILE
-------

  - Add support to template_url for heat stack profile. If template and template_url
    are both specified, use template. Need to refer to heat api test for testing heat
    profile.


POLICY
------
  - Provide support for watching all objects we created on behalf of users, like
    loadbalancer which is created when attaching lb policy.
  - Leverage other monitoring service for object health status monitoring.


DB
--
  - Add db purge (senlin-manage) for deleting events and actions because they
    accumulate very fast.


LOW PRIORITY
============

API
---
  - Add support to osprofiler which is a common library across all openstack
    projects for tracing and profiling.

ENGINE
------
  - Allow actions to be paused and resumed. This is important for some background
    actions such as health checking.
  - Add support to replace a cluster node with another node.
  - Provide support to oslo.notification and allow nodes to receive and react
    to those notifications accordingly: `Autoscaling Notifications`_

POLICY
------
  - Batching policy: create batchs for node creation/deletion/update.

PROFILE
-------
  - Support disk property update for os.nova.server profile

Receiver
--------
  - Zaqar queue based receiver.


DOC
-----
  - Provide a sample conf file for customizing senlin options.


.. _`Filtering Guidelines`: http://specs.openstack.org/openstack/api-wg/guidelines/pagination_filter_sort.html#filtering
.. _`Autoscaling Notifications`: https://ask.openstack.org/en/question/46495/heat-autoscaling-adaptation-actions-on-existing-servers/
{'fraction_non_alphanumeric': 0.08977630986338388, 'fraction_numerical': 0.004503828254015914, 'mean_word_length': 3.4119205298013244, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5839136', 'n_tokens_mistral': 1854, 'n_tokens_neox': 1750, 'n_words': 792}