DOCSEARCHbyAlgolia
Submit Docs

OpenGitOps Project Documentation

repository·main·Indexed 22 days ago

https://github.com/open-gitops/project

A CNCF Sandbox project dedicated to standardizing GitOps through vendor-neutral principles, a common glossary, and interoperability frameworks. This documentation covers project governance, contribution guidelines, team roles, branding assets, and a curated list of community learning resources including books and research papers.

Tokens
2.6K
Snippets
0
Records
16
Agent score
77%

What's inside OpenGitOps

  1. Overview of OpenGitOps

    main
    OpenGitOps is a CNCF Sandbox project dedicated to defining a vendor-neutral, principle-led definition of GitOps. Its goal is to establish a foundation for tool interoperability, conformance, and certification through standardized documents and code.

  2. Explore GitOps community learning resources

    main

    The OpenGitOps project maintains a curated list of community resources to support research and understanding of GitOps principles. These resources are categorized into several types:

    • Books: Comprehensive guides and textbooks (e.g., GitOps and Kubernetes, GitOps Cookbook).
    • Research Papers: Academic studies on GitOps methodologies and comparisons with DevOps.
    • Articles: Discussions on best practices, tool comparisons, and industry trends.
    • Documentation: Official or community guides for GitOps tools and frameworks.
    • Case Studies: Real-world organizational implementations.
    • Videos and Webinars: Recorded presentations and tool demonstrations.
    • Tutorials and Guides: Step-by-step instructions for implementation.
    • Courses and Training Materials: Structured learning paths and certifications.

    Note: These references are provided for informational purposes and do not constitute endorsements of specific tools or companies.

  3. Explore OpenGitOps repositories

    main

    The OpenGitOps project is distributed across several repositories depending on your needs:

    • documents: Contains versioned and released project documents, including the official GitOps Principles and Glossary.
    • events: Manages GitOps community events organized or curated by the GitOps WG Events Committee.
    • project: The top-level repository containing general project information.
    • website: The source code for the official OpenGitOps website.
    • .github: Contains organization-wide community health files (contributing guidelines, code of conduct, etc.).

  5. How decisions are made in OpenGitOps

    main

    OpenGitOps follows a hierarchy of decision-making processes to favor consensus:

    1. Consensus: The preferred method for all communications and decisions.
    2. Lazy Consensus: The starting point for most decisions. If no objections are raised, the decision proceeds.
    3. Maintainer Vote: If consensus cannot be reached and a deadline is threatened or there is unreasonable blocking, a formal vote is called among Maintainers via a GitHub issue. Votes are also announced on the CNCF SIG App Delivery mailing list (cncf-sig-app-delivery@lists.cncf.io).

    Voting Thresholds:

    • Simple Majority: More than half of all active Maintainers. This is the default for most votes.
    • Supermajority: Two-thirds or more of all active Maintainers. Required for:
      • Adding new Maintainers.
      • Moving a Maintainer to Inactive status.
      • Enforcing Code of Conduct violations.
      • Licensing and intellectual property changes.
      • Material changes to the Governance document.

  6. OpenGitOps team statuses

    main

    Teams in the OpenGitOps project are categorized by the following statuses:

    • active: Currently working and contributing.
    • proposed: Under discussion and awaiting formal creation.
    • paused: Work is temporarily suspended.
    • inactive: No longer active (often historic).

  7. Understand OpenGitOps project roles and responsibilities

    main

    The OpenGitOps project is organized into several tiers of involvement:

    • Community Members: Anyone interested in the project. They must follow the Code of Conduct and should not imply formal authority unless explicitly assigned a role.
    • Team Members: Volunteers who join specific teams to work on projects. They follow processes focused on inclusiveness, transparency, and respect.
    • Maintainers: Team members with significant, sustained contributions. They drive project direction, review pull requests, participate in voting, and manage the project's mission. Active Maintainers are listed in the MAINTAINERS file.
    • Inactive Maintainers: Maintainers who have been inactive for over 2 months or whose inactivity blocks a decision. They are listed in an "inactive" section of the MAINTAINERS file and their votes are not counted in majority tallies.
    • Chairs: Three Maintainers who co-chair the project for one-year terms. They manage the roadmap, handle Code of Conduct violations, coordinate workstreams, and ensure inclusive, asynchronous discussion. Current chairs are listed in CHAIRS.md.

  9. Participate in Chair elections

    main

    Chairs are elected for one-year terms via Ranked Choice Voting through the CNCF SIG App Delivery mailing list (cncf-sig-app-delivery@lists.cncf.io).

    Election Process:

    1. Nomination: A call for nominations is made on the mailing list. Candidates (who must be existing Maintainers) should submit a brief bio and personal statement.
    2. Organization Voting: To prevent single-entity dominance, a maximum of two individuals from a single organization (who are active CNCF members and listed in interested-parties.md) may vote. Interested parties must be added to the list at least one week before the election.
    3. Results: Results are announced on the mailing list, and CHAIRS.md is updated.

    Special Elections: Unscheduled elections occur if a chair steps down or if a change in affiliation causes an entity to become overrepresented.

  10. Access OpenGitOps logo assets and branding

    main

    The OpenGitOps project provides various logo formats (icon, stacked, and horizontal) in SVG format for use in documentation, websites, and other project materials.

    Available logo variations:

    • Icon: icon/color/opengitops-icon-color.svg
    • Stacked: stacked/color/opengitops-stacked-color.svg
    • Horizontal: horizontal/color/opengitops-horizontal-color.svg

    Source files are available in Adobe Illustrator .ai format in the ../src/ directory of the repository.

  11. Propose a new OpenGitOps team

    main

    If you want to create a new focus area, follow this process:

    1. Start a Discussion: Open a discussion topic in the open-gitops/project repository.
    2. Make a Case: Present a persuasive case for the new team and invite feedback from the community.
    3. Formalize via PR: If the proposal is deemed within the scope of the Working Group (WG) and there is sufficient interest, open a PR to create the team entry and add initial members in TEAMS.md.