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

Add glossary item for "pull" #65

Merged
merged 3 commits into from
Nov 29, 2023
Merged

Add glossary item for "pull" #65

merged 3 commits into from
Nov 29, 2023

Conversation

todaywasawesome
Copy link
Member

From this discussion: open-gitops/project#134

In light of ongoing discussions and questions in slack, of which this is the most recent example, it seems prudent to explain what pull means.

Sometimes, readers understand "pull" to mean that GitOps agents must live in the infrastructure under management so that it is self-sufficient and does not require external agents. This however, is not the intention of the word pull. The word pull here is specifically in reference to how desired state is discovered.

Signed-off-by: Dan Garfield dan@codefresh.io

Signed-off-by: Dan Garfield dan@todaywasawesome.com

@ubaumann
Copy link

I would like it if there would be something about the fact, that the GitOps agent needs to be able to access the SSoT at any time.

Maybe we add the following sentence?

In contrast to traditional, CI/CD pipelines which "push" event based triggers to discover state changes, in GitOps desired state is "pulled". The GitOps agents need to be able to access the desired state at any time to avoid drifts. This state may be reconciled with local or remote actual states. In GitOps agents are expected to pull both desired and actual states without the requirement of events. Webhooks may be used to speed up this process, but should a webhook fail, the agent is still expected to discover changes to desired state by pulling from the source of truth.

@scottrigby
Copy link
Member

Thanks @todaywasawesome for hopping on this.

@ubaumann I agree, from Slack and elaborated in this discussion answer open-gitops/project#134 (comment) WDYT?

Copy link
Member

@scottrigby scottrigby left a comment

Choose a reason for hiding this comment

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

Dan what do you think about this? building on what you wrote but also with more direct ties to existing content. If so you can merge this suggestion into your PR branch directly (number 3 in Incorporating feedback in your pull request).

GLOSSARY.md Outdated Show resolved Hide resolved
@scottrigby
Copy link
Member

scottrigby commented Mar 21, 2023

Great 👍 Now just looks like DCO bot is unhappy with email mismatch:

Commit sha: 984ed8e, Author: Dan Garfield, Committer: GitHub; Can not find "Dan Garfield dan@todaywasawesome.com", in ["Dan Garfield dan@codefresh.io", "Dan Garfield dan@codefresh.io"].

Steps to fix: https://github.com/open-gitops/documents/runs/12166015365

todaywasawesome and others added 2 commits April 7, 2023 10:44
Signed-off-by: Dan Garfield <dan@codefresh.io>

Signed-off-by: Dan Garfield <dan@todaywasawesome.com>
Signed-off-by: Dan Garfield <dan@codefresh.io>
Signed-off-by: Dan Garfield <dan@codefresh.io>

Co-authored-by: Scott Rigby <scott@r6by.com>
Signed-off-by: Dan Garfield <dan@codefresh.io>
@todaywasawesome todaywasawesome marked this pull request as ready for review April 7, 2023 16:45
Signed-off-by: Dan Garfield <dan@codefresh.io>
@ubaumann
Copy link

ubaumann commented Apr 8, 2023

@todaywasawesome Looks good to me! It makes it much more straightforward. Thanks

@scottrigby
Copy link
Member

After merging this, we can create a v1.1.0 draft similar to how we did 1.0.0.

Copy link
Member

@niklasmtj niklasmtj left a comment

Choose a reason for hiding this comment

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

LGTM

@scottrigby
Copy link
Member

Ok this has been open for review in its current state for a good while now, has multiple collaborators/co-authors, and 4 maintainer approvals. Merging. Thanks everyone! 🚀

@scottrigby scottrigby merged commit f99a910 into main Nov 29, 2023
@scottrigby scottrigby deleted the todaywasawesome-pull branch November 29, 2023 17:31
scottrigby added a commit to scottrigby/ogo-documents that referenced this pull request Dec 4, 2023
Signed-off-by: Scott Rigby <scott@r6by.com>
@scottrigby scottrigby added this to the v1.1.0 milestone Jun 24, 2024
@scottrigby scottrigby added the enhancement New feature or request label Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants