Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Planning Work: Extend Cylc Run (Replace Rose Suite Run) #40

Merged
merged 9 commits into from
Aug 27, 2019

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Jul 24, 2019

  • Roadmap for small PRs to a dev branch added.
  • Added a basic example suite.rc file
  • Proposed changes to naming conventions
  • Clarify naming conventions
  • Clarify tasks to be undertaken
  • Move task list near to top of plan doc, or to a separate document
  • Create issues for each identified task.
  • Expand on discussion of rose-suite.conf deprecation.

@wxtim wxtim force-pushed the rose-suite-run-proposals-changes branch from 61b27c4 to 88500cf Compare July 30, 2019 08:31
@wxtim wxtim changed the title Proposed changes Work on changes to cylc run to make rose-suite run unecessary Jul 30, 2019
@wxtim wxtim requested a review from matthewrmshin July 30, 2019 13:40
@hjoliver
Copy link
Member

We should call all of these files flow.rc (or cylc-flow.rc) and they will share the same schema.

I prefer cylc-flow.rc ... to leave no ambiguity about the file's purpose in life.

@wxtim wxtim changed the title Work on changes to cylc run to make rose-suite run unecessary Planning Work: Extend Cylc Run (Replace Rose Suite Run) Jul 31, 2019
@wxtim wxtim force-pushed the rose-suite-run-proposals-changes branch from c8c0315 to c10ebdc Compare August 1, 2019 08:37
- [ ] Include suite validation in `cylc flow` CLI.


- [ ] Replace `rose-suite.conf`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like the bottom half of this list is increasingly sketchy. I'd be happier of people with bigger domain knowledge might care to colour it in a bit...

@@ -0,0 +1,42 @@
Placeholder - populate in new PR
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not anticipated that this is the finished form of the document: One of the tasks on the work plan is, after all, to summarize the debate in this document in another PR.

- Roadmap for small PRs to a dev branch added.
- Clarification of terminology for job platforms
- Some thoughts on `cylc flow --options`
- Added stub files for development plan documentation

moved some detail on future CLI into another folder.
@oliver-sanders
Copy link
Member

Should include something in this document about registering runs under the name of the template suite as discussed in June e.g.:

mi-aa001/
    run1
    run2

docs/proposal-rose-suite-run.md Outdated Show resolved Hide resolved
@wxtim
Copy link
Member Author

wxtim commented Aug 15, 2019

Can I please ask @oliver-sanders and/or @sadielbartholomew and or @matthewrmshin to formally review this plan. I think I should get it in, especially as it's a little bit meta (it calls for further planning of the new names for cylc ???? and the replacement .rc files.)

docs/proposal-rose-suite-run.md Outdated Show resolved Hide resolved
docs/proposal-rose-suite-run.md Outdated Show resolved Hide resolved
docs/proposal-rose-suite-run.md Show resolved Hide resolved
* `rose suite-run` does not currently validate Rose items. This should be
changed to ensure that all aspects of the suite are validated uniformly.
* `rose suite-run` does not currently validate Rose apps against their
metadata. Rose apps should be validated against their metadata by default,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To clarify are you suggesting a Rose plugin to Cylc which validates all applications during the suite install process?

Conceptually sounds good to me but we may need to consult users before considering this as it is potentially controversial.

Rose has different levels of validation:

  • Built-in (fast)
  • Fail-if Warn-if (fastish)
  • Macros (slow)

What level would we validate to? Would we validate optional configs?

We might want to upgrade rose macro to use asyncio or multiprocessing.

Copy link
Member Author

@wxtim wxtim Aug 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that is the general plan, but I agree, there is the possibility of some controversy. I don't really have answers to your questions and I'm open to suggestions at this point.

I suspect that validation level might validate to Fail-if Warn-if. - Might it be possible for it to print out a warning which includes the contents of the YML file required if the user wishes to change the validation level?

docs/proposal-rose-suite-run.md Outdated Show resolved Hide resolved
docs/proposal-rose-suite-run.md Outdated Show resolved Hide resolved
Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, though I have limited knowledge about Rose. I might be able to do a better review in subsequent issues focused on each step required for the replacement of rose suite run, by testing, looking at the code changes, etc.

@wxtim
Copy link
Member Author

wxtim commented Aug 27, 2019

I'm going to merge this: It's a working document under version control. Thank you all for your help on this - no doubt there will be more to come....

@wxtim wxtim merged commit 0679241 into cylc:master Aug 27, 2019
@sadielbartholomew sadielbartholomew removed their request for review October 25, 2019 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants