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

[EN] update GitOps #2121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MaryamTavakkoli
Copy link
Contributor

@MaryamTavakkoli MaryamTavakkoli commented Jun 11, 2023

Describe your changes

Updated an existing term - GitOps

Related issue number or link (ex: resolves #issue-number)

Resolves #2073 and #372

Checklist before opening this PR (put x in the checkboxes)

  • This PR does not contain plagiarism
    • don’t copy other people’s work unless you are quoting and contributing it to them.
  • I have signed off on all commits
    • signing off (ex: git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to your gitconfig by running git config --global alias.ci "commit -s".

@netlify
Copy link

netlify bot commented Jun 11, 2023

Deploy Preview for cncfglossary ready!

Name Link
🔨 Latest commit 38dd8cb
🔍 Latest deploy log https://app.netlify.com/sites/cncfglossary/deploys/674f8c3e234e6400083dc8ba
😎 Deploy Preview https://deploy-preview-2121--cncfglossary.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the lang/en for English label Jun 11, 2023
@nate-double-u nate-double-u self-requested a review June 12, 2023 19:17
@nate-double-u nate-double-u changed the title [EN] Update an existing term (GitOps) [EN] update GitOps Jun 19, 2023
@nate-double-u nate-double-u mentioned this pull request Jun 28, 2023
2 tasks
@jihoon-seo jihoon-seo mentioned this pull request Jul 14, 2023
6 tasks
@iamNoah1 iamNoah1 added the update term Updates to existing terms label Jul 31, 2023
@nate-double-u
Copy link
Member

Sorry for the delay on this review. I've rebased this on main to bring it back up to date.

Copy link
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

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

Hi @MaryamTavakkoli,

Thanks for this. I've made a couple updates in-line. @iamNoah1, maybe you could take a look as well.

Comment on lines +8 to 16
GitOps is a set of best practices for managing software systems
from the beginning of the development workflow, all the way to deployment
based on [shared (OpenGitOps) principles](https://opengitops.dev/).

GitOps requires the desired state or configuration of the system to
be stored in a source control system like Git.
These practices are then used to execute a cohesive workflow that
leverages a source control system like Git as the “single source of truth” and
extends this practice to applications, infrastructure, and operational procedures.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
GitOps is a set of best practices for managing software systems
from the beginning of the development workflow, all the way to deployment
based on [shared (OpenGitOps) principles](https://opengitops.dev/).
GitOps requires the desired state or configuration of the system to
be stored in a source control system like Git.
These practices are then used to execute a cohesive workflow that
leverages a source control system like Git as the “single source of truth” and
extends this practice to applications, infrastructure, and operational procedures.
GitOps is a set of best practices for managing software systems from development
to deployment based on [shared OpenGitOps principles](https://opengitops.dev/).
It requires the desired state or configuration of the system to be stored in a source
control system like Git, serving as the single source of truth.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@nate-double-u I would remove the reference to OpenGitOps. I think nowhere in the glossary we have references to other resources. Also I personally am not sure if GitOps was originated from OpenGitOps principles which this statement might imply.

Comment on lines -17 to +25
Existing processes for infrastructure configuration management can face challenges
such as configuration drift, failed deployments, relying on a system's previous state for success,
missing documentation, or unknown development history.
Adopting a GitOps workflow can help alleviate these issues, among several others.
Existing processes for configuration management can face
challenges such as configuration drift, failed deployments, inconsistency
across different infrastructure, or unknown development history.
Emphasising on continues deployment and delivery,
a GitOps workflow can help alleviate these issues,
among several others.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Existing processes for infrastructure configuration management can face challenges
such as configuration drift, failed deployments, relying on a system's previous state for success,
missing documentation, or unknown development history.
Adopting a GitOps workflow can help alleviate these issues, among several others.
Existing processes for configuration management can face
challenges such as configuration drift, failed deployments, inconsistency
across different infrastructure, or unknown development history.
Emphasising on continues deployment and delivery,
a GitOps workflow can help alleviate these issues,
among several others.
Existing processes for configuration management can face challenges such as
configuration drift, failed deployments, inconsistency across different infrastructure,
and unknown development history. By emphasizing continuous deployment and
delivery, GitOps helps alleviate these issues.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Approved but I cannot signoff and commit through the webui, it says it cannot apply suggestions on deleted lines ^^

Comment on lines 29 to +38
GitOps is a paradigm that can be applied to a workflow
to help manage an application and cloud system infrastructure.
It enables organizations several advantages
such as better coordination, transparency, stability, and reliability of a system.
Operating in a close loop ensures the current live state of a system matches
against the desired target state, specified in the git repository.
Moreover, it helps organizations to manage the entire infrastructure
and application development and deployment lifecycle using a
single and unified tool.

GitOps brings organizations several other advantages
such as transparency and traceability of changes,
reliability and security through declarative states,
and rollback, revert and self-healing attributes.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
GitOps is a paradigm that can be applied to a workflow
to help manage an application and cloud system infrastructure.
It enables organizations several advantages
such as better coordination, transparency, stability, and reliability of a system.
Operating in a close loop ensures the current live state of a system matches
against the desired target state, specified in the git repository.
Moreover, it helps organizations to manage the entire infrastructure
and application development and deployment lifecycle using a
single and unified tool.
GitOps brings organizations several other advantages
such as transparency and traceability of changes,
reliability and security through declarative states,
and rollback, revert and self-healing attributes.
GitOps helps organizations manage the entire infrastructure and application
lifecycle using a unified tool. It brings advantages such as transparency and
traceability of changes, reliability and security through declarative states, and
rollback, revert, and self-healing attributes.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Approved but I cannot signoff and commit through the webui, it says it cannot apply suggestions on deleted lines ^^

Copy link
Collaborator

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

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

@nate-double-u left some comments, also please check the spellcheck which is failing atm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang/en for English update term Updates to existing terms
Projects
Status: 📋 Backlog
Development

Successfully merging this pull request may close these issues.

version control & gitops
3 participants