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

docs: Add pipelines description and limitations #188

Closed
wants to merge 6 commits into from

Conversation

yiannistri
Copy link
Collaborator

@yiannistri yiannistri commented Jul 14, 2023

This PR adds a diagram and a description of how pipelines work currently. It also summarises the main limitations that have been reported from users.

@yiannistri yiannistri force-pushed the pipeline-controller-diagram branch from 42d4127 to 9335b99 Compare July 14, 2023 10:51
### Limitations

- The current solution expects all the target environments to be specified in the Pipeline CR. Because of this, pipelines that need to target hundreds of environments require a lot of effort from the user in order to keep the CR up-to-date.
- The first environment of the pipeline is expected to be set up already before any promotions take place. In fact, the pipelines feature as a whole does very little to help the user establish a full CD pipeline. A better approach would be for the user to describe **what** and **where** and the pipeline controller to take care of the rest across **all** environments, including the first one.

Choose a reason for hiding this comment

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

I'd flesh out the wording a bit:

"for the user" -- yesterday, we suggested that this person would be an app developer
"to describe what" -- follow up with "they want to deploy (GitRepository + Kustomization)"
"and where:" -- follow up with "fleets of clusters"

@yiannistri yiannistri closed this Oct 31, 2023
@yiannistri yiannistri deleted the pipeline-controller-diagram branch October 31, 2023 18:09
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.

2 participants