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

unclear documentation comments for persistence in workflow-controller-configmap.yaml #2156

Closed
eug48 opened this issue Feb 4, 2020 · 7 comments · Fixed by #2172
Closed

unclear documentation comments for persistence in workflow-controller-configmap.yaml #2156

eug48 opened this issue Feb 4, 2020 · 7 comments · Fixed by #2172
Assignees
Labels

Comments

@eug48
Copy link

eug48 commented Feb 4, 2020

Currently workflow-controller-configmap.yaml has

      # save the entire workflow into etcd and DB
      nodeStatusOffLoad: false
      # save completed workloads to the archived, even if disabled, you'll be able to
      # read from the archive
      archive: false

Perhaps more clearer would be "nodeStatusOffLoad if false saves the entire workflow into both etcd and the persistence DB, if true node status is only saved to the persistence DB to avoid the 1MB limit in etcd".

For archive the wording appears to have a typo and is unclear about what can be read from the archive.

Thanks very much for all the great work!

@eug48 eug48 added the type/bug label Feb 4, 2020
@alexec alexec self-assigned this Feb 4, 2020
@alexec alexec added the docs label Feb 4, 2020
@alexec
Copy link
Contributor

alexec commented Feb 4, 2020

See #2170

@eug48
Copy link
Author

eug48 commented Feb 5, 2020

@alexec the linked PR does improve the comment for nodeStatusOffLoad, but not for archive

@alexec
Copy link
Contributor

alexec commented Feb 5, 2020

@alexec the linked PR does improve the comment for nodeStatusOffLoad, but not for archive

better now?

@eug48
Copy link
Author

eug48 commented Feb 5, 2020

a bit better but what I still don't clearly understand is that if archive is false what gets stored in the persistence DB if nodeStatusOffLoad is false and if nodeStatusOffLoad true?

@alexec
Copy link
Contributor

alexec commented Feb 5, 2020

the two features are independent - the whole workflow is store in the archive, including any data that was offloaded (or not)

@eug48
Copy link
Author

eug48 commented Feb 6, 2020

So if both nodeStatusOffLoad: false and archive: false then nothing is written to the persistence DB?

And if nodeStatusOffLoad: true and archive: false just the nodeStatus is temporarily written to the DB but then deleted?

@alexec
Copy link
Contributor

alexec commented Feb 6, 2020

correct - the node status is deleted when the workflow is deleted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants