conf: ensure all proposed changes have been enacted

[oliver-sanders]

Ensure all changed document in the config change proposal document have been implemented pre 8.0.0 release.

Pull requests welcome!

[wxtim]

Copied from https://cylc.github.io/cylc-admin/proposal-config-changes.html#agreed-global-config-changes

Global Config Checklist

These don't need upgraders for Cylc 8.

• [authentication] -> obsolete (flow-cfg-update.authentication #3845)
• [cylc][events]mail * -> [scheduler][mail] (move [cylc][events]mail (.*) -> [cylc][mail] #3846)
• [cylc][events] -> [scheduler][events] (@wxtim conf: 'cylc' => 'scheduler' #3907)
• [cylc]task event mail interval -> [scheduler][mail]task event batch interval (move [cylc][events]mail (.*) -> [cylc][mail] #3846)
• [cylc]health check interval -> [scheduler]health check interval obsolete (main loop: plugins for periodic functions #3492)
• process pool * -> [scheduler]process pool * (Global config changes: process pool, logging #3943)
• [documentation] -> obsolete (remove documentation and document viewers section from global config. #3911)
• [document viewers] -> obsolete (remove documentation and document viewers section from global config. #3911)
• [suite logging] -> [scheduler][logging] (Global config changes: process pool, logging #3943)
• run directory rolling archive length -> [scheduler]run directory rolling archive length (Global config changes: process pool, logging #3943)
• [task events]mail smtp -> obsolete (Finish off mail config changes #3914)
• [task events]mail retry delays -> obsolete (Finish off mail config changes #3914)
• [suite servers]auto restart delay -> [scheduler]auto restart delay (@wxtim move suite servers to scheduler section of global config #3962)
• [suite servers]run hosts -> [scheduler][run hosts]available (@wxtim move suite servers to scheduler section of global config #3962)
• [suite servers]condemned hosts -> [scheduler][run hosts]condemned (@wxtim move suite servers to scheduler section of global config #3962)
• [suite servers]run ports -> [scheduler][run hosts]ports (@wxtim move suite servers to scheduler section of global config #3962)
• [suite servers]ranking -> [scheduler][run hosts]ranking (@wxtim move suite servers to scheduler section of global config #3962)
• [suite host self-identification] -> [scheduler][host self-identification] (@wxtim move suite servers to scheduler section of global config #3962)
• [job platforms] -> [platforms] (Insert Basic Platforms Functionality (formerly 'plumbing') #3626)
• [job platforms][]task communication method -> [platforms][]communication method (Insert Basic Platforms Functionality (formerly 'plumbing') #3626)
• [cylc]UTC mode -> [scheduler]UTC mode (@wxtim conf: 'cylc' => 'scheduler' #3907)
• [editors] - discussed at CylcCon. Agreed to keep these settings but discourage their use. Also, change them to use to $EDITOR & $GEDITOR if set (otherwise use current defaults).
• disable interactive command prompts -> obsolete (Remove interactive prompt support #3774)
• [test battery] -> obsolete (7d928e1)
• [job platforms][]batch system -> [platforms][]job runner (batch system -> job runner #3992)
• [job platforms][]batch submit command template -> [platforms][]job runner command template (batch system -> job runner #3992)
• [job platforms][]task event handler retry delays -> obsolete (remove from [platforms]: scp command, task event handler retry delays #3908)
• [job platforms][]scp command -> obsolete (remove from [platforms]: scp command, task event handler retry delays #3908)
• Remove the cylc [util] scp-transfer command. (remove cylc scp-transfer #3634)

Suite Config Checklist

Don't forget to add upgraders

• [cylc]force run mode & required run mode -> obsolete (workflow config update: remove force/require run mode #3844)
• [visualization] -> obsolete (Covered separately by Replace the old [visualization] section #3379, Hopefully closed by Remove obsolete visualization section. #4273)
• [cylc][authentication] -> obsolete (flow-cfg-update.authentication #3845)
• [cylc]disable automatic shutdown -> obsolete (Remove "disable automatic shutdown" #3942)
• [cylc][parameters] -> [task parameters] (@wxtim Replace [scheduling][parameters] with [task parameters] #3963 )
• [cylc][parameter templates] -> [task parameters][templates] (@wxtim Replace [scheduling][parameters] with [task parameters] #3963 )
• [scheduling]hold after point -> [scheduling]hold after cycle point (Workflow config changes: environment, hold after point #3947)
• [scheduling]stop after cycle point <- new (Config change.stop after cycle point #3883)
• [scheduling][special tasks]exclude at start-up & include at start-up -> obsolete (@wxtim removed [cylc]exclude at start-up and [cylc]include at start-up #3967 )
• [runtime][][job] -> [runtime][] (This applies only to the settings which have not been deprecated by the platforms work: execution polling intervals, execution retry delays, execution time limit, submission polling intervals & submission retry delays. See discussion and moved execution and submission items from [task][job] to [task] #3480.) Upgrade code in master and commented atm. (Move items from [task][job] to [task] #3968, Added an explanation on the reference docs for Cylc7 legacy host/remo… #4075)
• [runtime][][remote]suite definition directory -> obsolete (Note that we also need to deprecate the environment variables $CYLC_SUITE_DEF_PATH & $CYLC_SUITE_DEF_PATH_ON_SUITE_HOST.) (Make obsolete [runtime][][remote]suite definition directory #4126)
• [cylc][events]mail * -> [scheduler][mail] (move [cylc][events]mail (.*) -> [cylc][mail] #3846)
• [cylc][events]mail smtp -> obsolete (Finish off mail config changes #3914)
• [cylc][events] -> [scheduler][events] (@wxtim conf: 'cylc' => 'scheduler' #3907)
• [cylc]task event mail interval -> [scheduler][mail]task event batch interval (move [cylc][events]mail (.*) -> [cylc][mail] #3846)
• [runtime][][events]mail smtp -> obsolete (Finish off mail config changes #3914)
• [runtime][][events]mail retry delays -> obsolete (move [cylc][events]mail (.*) -> [cylc][mail] #3846)
• [cylc][reference test]expected task failures -> [scheduler][events]expected task failures (Workflow config changes: expected task failures #3957)
• [scheduler][events]abort if any task fails -> obsolete (3695.abort if any task fails #3785)
• [cylc][environment] -> obsolete (Workflow config changes: environment, hold after point #3947)
• [cylc]health check interval -> [scheduler]health check interval obsolete (main loop: plugins for periodic functions #3492)
• [cylc] time settings -> [scheduler] (This covers UTC mode, cycle point format, cycle point num expanded year digits and cycle point time zone (discussed at CylcCon)). (@wxtim conf: 'cylc' => 'scheduler' #3907)
• [cylc][simulation]disable suite event handlers -> obsolete (Agreed at CylcCon to move this and make it positive. However, now proposing to remove it and automatically disable event handlers in simulation and dummy modes. It’s easy to test event handlers, if you need to, in a real test suite written for that purpose and there’s no obvious use case for this when running a real suite in simulation or dummy mode.) (conf: disable suite event handlers #3972)
• [runtime][]extra log files -> obsolete (@wxtim remove 'extra log files' from config #3969)

Other tasks

• Create a change guide in cylc/doc - Pass to issue 7-to-8 migration guide cylc-doc#170
• Final sanity check that everything matches in the cylc/admin doc because the checklist was created by a massive crude copy and paste. @dpmatthews
• Review documentation embedded in config.

[MetRonnie]

Might be a good idea to add our names next to items in the checklist when we start working on them, to avoid two people doing the same one

[hjoliver]

😖 sorry @wxtim that was definitely accidental.

[MetRonnie]

[cylc]health check interval -> [scheduler]health check interval

This seems to be entirely missing from global config. Anyone know what happened to it? Ah, I see it was changed in #3492: [cylc]health check interval -> [cylc][main loop][health check]interval

[oliver-sanders]

Ah yeah #3492 made health check a configurable plugin, good to leave it as [scheduler][main loop][health check]interval.

[wxtim]

So I think that's everything which isn't blocked!

[MetRonnie]

Oops, I still need to do #3910

[hjoliver]

So I think that's everything which isn't blocked!

Wow that was a load of PRs, well done 💐

[wxtim]

• Create change guide in docs - pass to issue 7-to-8 migration guide cylc-doc#170

[oliver-sanders]

#4034

[MetRonnie]

I've unticked

[editors] - discussed at CylcCon. Agreed to keep these settings but discourage their use. Also, change them to use to $EDITOR & $GEDITOR if set (otherwise use current defaults).

because we haven't discouraged their use or set them to use $EDITOR or $GEDITOR by default.

Also

[visualization] -> obsolete

because we haven't done it yet, even if it's covered by another issue

[oliver-sanders]

because we haven't discouraged their use or set them to use $EDITOR or $GEDITOR by default.

Was done by #3692

[MetRonnie]

Ah ok, is the "if unspecified Cylc will use $(G)EDITOR" spiel enough to consider their use discouraged?

[oliver-sanders]

I think the "discourage use" was more aimed at the [editors] section i.e. stop calling out to text editors from code, not sure.

[oliver-sanders]

for