StackStorm / st2

StackStorm (aka "IFTTT for Ops") is event-driven automation for auto-remediation, incident responses, troubleshooting, deployments, and more for DevOps and SREs. Includes rules engine, workflow, 160 integration packs with 6000+ actions (see https://exchange.stackstorm.org) and ChatOps. Installer at https://docs.stackstorm.com/install/index.html
https://stackstorm.com/
Apache License 2.0
5.95k stars 741 forks source link

Rename config section [workflow_engine] to [workflowengine] #4316

Open nmaludy opened 5 years ago

nmaludy commented 5 years ago
SUMMARY

To be consistent with other config sections, the [workflow_engine] section should be renamed to [workflowengine]

ISSUE TYPE
STACKSTORM VERSION
$ st2 --version
st2 2.8.1, on Python 2.7.5
EXPECTED RESULTS

The [workflowengine] section name is used for Orquesta config options.

Kami commented 5 years ago

Agreed, I'm not a fan of those inconsistencies myself (we have a similar story for timersengine, IIRC).

I would prefer to use underscore everywhere, but this would mean more work and more changes so no underscores is probably a way to go forward...

nmaludy commented 5 years ago

Yeah, i don't care either way TBH, just want to be consistent.

One thing i do like is that the heading names match the names of the Linux services (resultstracker == st2resultstracker) makes it easy to find / grep for stuff.

arm4b commented 5 years ago

+1 to @nmaludy for using [workflowengine] instead of [workflow_engine]

Even considering that @Kami and @m4dcoder are in favor of using _ underscore in naming (see https://github.com/StackStorm/st2/pull/4185#discussion_r197097635) and @lakshmi-kannan is against that, I now have decent argument for not using underscore.

The example is simple: iterating over workflowengine timersengine should work fine to template st2.conf sections. Adding st2 prefix to that should produce name for st2 service/component name.

Eg. by giving service name like st2workflowengine, we should use st2.conf section naming in a similar way workflowengine, not workflow_engine, otherwise templating becomes hard and inconsistent.

arm4b commented 5 years ago

@nmaludy Heh, same idea with following original st2 service naming :+1: Seems we hit similar difficulties during the ops work.