Skip to content

Extend documentation on DependentResources/Workflows #1476

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

Closed
andreaTP opened this issue Sep 16, 2022 · 5 comments
Closed

Extend documentation on DependentResources/Workflows #1476

andreaTP opened this issue Sep 16, 2022 · 5 comments
Labels
documentation-epic lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@andreaTP
Copy link
Collaborator

The documentation regarding DependentResources and Workflows is pretty minimal and focuses on very very few examples close to "hello world".
It would be nice to see more extensive examples covering more "real-world-like" use cases.

Especially speaking about Workflow a lot of combinations/variations of the possible configurations are left to the user's imagination and reading the source code.

@grossws
Copy link

grossws commented Oct 21, 2022

Also current docs have some obvious typos like Reconsiler and Cleaner for different CRDs, there's no source for conditions etc.

@ControllerConfiguration(dependents = {
    @Dependent(name = DEPLOYMENT_NAME, type = DeploymentDependentResource.class,
        readyPostcondition = DeploymentReadyCondition.class),
    @Dependent(type = ConfigMapDependentResource.class,
        reconcilePrecondition = ConfigMapReconcileCondition.class,
        deletePostcondition = ConfigMapDeletePostCondition.class,
        dependsOn = DEPLOYMENT_NAME)
})
public class SampleWorkflowReconciler implements Reconciler<TestCustomResource>,
    Cleaner<WorkflowAllFeatureCustomResource> {
  // ...
}

@csviri
Copy link
Collaborator

csviri commented Oct 24, 2022

thx @grossws , fixed here: #1568

@github-actions
Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 24, 2022
@metacosm metacosm removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 2, 2023
@github-actions
Copy link

github-actions bot commented Mar 4, 2023

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 4, 2023
@github-actions
Copy link

This issue was closed because it has been stalled for 14 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-epic lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

4 participants