From 9319d01ad834339985af8e3501c7e62dfed0d062 Mon Sep 17 00:00:00 2001 From: Samuel Tauil Date: Thu, 18 Jul 2024 15:37:33 -0400 Subject: [PATCH 01/10] Adding a reference section with bibtex Signed-off-by: Samuel Tauil --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index c6c8655..5d93700 100644 --- a/README.md +++ b/README.md @@ -23,3 +23,17 @@ For more information about the OpenGitOps project, see: Date: Mon, 22 Jul 2024 12:39:03 -0400 Subject: [PATCH 02/10] Adding Refence Materials page base format Signed-off-by: Samuel Tauil --- REFERENCES.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 REFERENCES.md diff --git a/REFERENCES.md b/REFERENCES.md new file mode 100644 index 0000000..934da06 --- /dev/null +++ b/REFERENCES.md @@ -0,0 +1,87 @@ +# Reference Material + +The reference material entries listed in this document are contributions covering GitOps principles and related topics. They do not constitute endorsements or affiliations with any specific tools, solutions, or companies mentioned in these documents. The inclusion of references is purely for academic or informational purposes to support understanding and research in the field of GitOps. If you want to include any related material please submit a PR. + +## Categories of GitOps Materials + +1. **Books** + - Comprehensive guides or textbooks covering GitOps principles, practices, and implementations. + +2. **Research Papers** + - Academic papers exploring various aspects of GitOps, including methodologies, comparisons with other DevOps practices, and empirical research. + +3. **Articles** + - Online or print articles discussing specific aspects of GitOps, such as tutorials, best practices, tool comparisons, and industry trends. + +4. **Documentation** + - Official or community-contributed documentation for GitOps tools, platforms, and frameworks, providing guidance on installation, configuration, and usage. + +5. **Case Studies** + - Real-world examples and case studies showcasing organizations' experiences and benefits of implementing GitOps practices in different environments. + +6. **Videos and Webinars** + - Recorded talks, presentations, or webinars discussing GitOps concepts, tool demonstrations, case studies, and expert interviews. + +7. **Tutorials and Guides** + - Step-by-step tutorials, guides, or manuals providing instructions on how to implement specific GitOps practices, set up tools, or solve common challenges. + +8. **Courses and Training Materials** + - Online courses, workshops, or training materials offering structured learning paths, certifications, and hands-on exercises focused on GitOps concepts and tools. + + +## Books + +| Book Name | Authors | Published Date | Publisher | ISBN | +|-----------------------------------|------------------|----------------|-----------------|----------------| +| *GitOps and Kubernetes* | Billy Yuen, Alexander Matyushentsev, Todd Ekenstam and Jesse Suen | February 2021 | Manning | 9781617297274 | +| *GitOps Cookbook* | Natale Vinto and Alex Soto Bueno | January 2023 | O'Reilly Media, Inc | 9781492097471 | +| *GitOps: Cloud-native Continuous Deployment* | Anja Kammer, Florian Beetz and Simon Harrer | July 2021 | Innoq Deutschland Gmbh | 9783982112688 | +| *Repeatability, Reliability, and Scalability through GitOps: Continuous delivery and deployment codified* | Bryan Feuling | May 2021 | Packt | 9781801077798 | +| *Practical Gitops: Infrastructure Management Using Terraform, Aws, and Github Actions* | Rohit Salecha | December 2022 | Apress | 9781484286722 | + +## Research Papers + +| Paper Title | Authors | Journal/Conference | Year | DOI/URL | +|-----------------------------------|------------------|--------------------|------|-------------------------| +| *Prevalence of GitOps, DevOps in Fast CI/CD Cycles* | Saumya Gupta, Madhulika Bhatia, Meenakshi Memoria and Preeti Manani | *2022 International Conference on Machine Learning, Big Data, Cloud and Parallel Computing (COM-IT-CON)* | 2022 | https://doi.org/10.1109/COM-IT-CON54601.2022.9850786 | +| *GitOps: The Evolution of DevOps?* | Florian Beetz and Simon Harrer | *IEEE Software ( Volume: 39, Issue: 4, July-Aug. 2022)* | 2022 | https://doi.org/10.1109/MS.2021.3119106 | +| *Continuous Deployment in IoT Edge Computing : A GitOps implementation* | Ramón López-Viana, Jessica Díaz and Jorge E. Pérez | *2022 17th Iberian Conference on Information Systems and Technologies (CISTI)* | 2022 | https://doi.org/10.23919/CISTI54924.2022.9820108 | +| *Analysis on the Use of Declarative and Pull-based Deployment Models on GitOps Using Argo CD* | Ramadoni, Ema Utami and Hanif Al Fatta | *2021 4th International Conference on Information and Communications Technology (ICOIACT)* | 2021 | https://doi.org/10.1109/ICOIACT53268.2021.9563984 | +| *Implementing DevOps Practices in CPPS Using Microservices and GitOps* | István Koren, Felix Rinker, Kristof Meixner, Moritz Kröger and Michael Zeng | *2023 IEEE 28th International Conference on Emerging Technologies and Factory Automation (ETFA)* | 2023 | https://doi.org/10.1109/ETFA54631.2023.10275433 | + +## Articles + +| Article Title | Authors | Publication Date | Source | URL | +|-----------------------------------|------------------|------------------|----------------|-------------------------| +| | | | | | + +## Documentation + +| Document Title | Authors/Contributors | Version | Date Updated | Source/URL | +|-----------------------------------|----------------------|---------|--------------|--------------------------| +| | | | | | + +## Case Studies + +| Case Study Title | Organization | Date Published | Industry | Description/Summary | +|-----------------------------------|------------------|----------------|----------------|--------------------------| +| | | | | | + +## Video and Webinars + +| Video/Webinar Title | Speaker(s) | Date Recorded | Platform | URL | +|-----------------------------------|------------------|-----------------|----------------|-------------------------| +| | | | | | + +## Tutorials and Guides + +| Tutorial/Guide Title | Author(s) | Date Published | Platform | URL | +|-----------------------------------|------------------|-----------------|----------------|-------------------------| +| | | | | | + +## Courses and Training Materials + +| Course/Training Title | Provider | Date Released | Format | URL | +|-----------------------------------|------------------|-----------------|----------------|-------------------------| +| | | | | | + From 2bdf213e972bb037b6444135386f2a0fab8e7866 Mon Sep 17 00:00:00 2001 From: Samuel Tauil Date: Tue, 23 Jul 2024 10:46:10 -0400 Subject: [PATCH 03/10] Title change Signed-off-by: Samuel Tauil --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d93700..5e6b84a 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ A [BibTex](https://www.bibtex.org) code snippet to use as reference for the cont ``` @misc{open_gitops, author = {{Open GitOps Project}}, - title = {{Open GitOps Documents - Glossary and Principles}}, + title = {{GitOps Principles and Glossary}}, howpublished = {\url{https://github.com/open-gitops/documents}}, note = {Accessed: YYYY-MM-DD}, year = {ongoing} From 0a5fa01f702c5663258dcb34b93e5d31e375aec7 Mon Sep 17 00:00:00 2001 From: Samuel Tauil Date: Thu, 8 Aug 2024 16:03:39 -0400 Subject: [PATCH 04/10] Add authors and fix bibtex reference Signed-off-by: Samuel Tauil --- README.md | 7 +++---- authors.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 4 deletions(-) create mode 100644 authors.md diff --git a/README.md b/README.md index 5e6b84a..bc928cb 100644 --- a/README.md +++ b/README.md @@ -24,16 +24,15 @@ For more information about the OpenGitOps project, see: Date: Thu, 8 Aug 2024 16:13:38 -0400 Subject: [PATCH 05/10] Direct link fix to the 1.1.0 release Signed-off-by: Samuel Tauil --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bc928cb..381df45 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ A [BibTex](https://www.bibtex.org) code snippet to use as reference for the cont @misc{open_gitops, title = {{GitOps Principles and Glossary}}, howpublished = {\url{https://github.com/open-gitops/documents}}, - note = {Accessed: YYYY-MM-DD. For an up-to-date list of authors, see \url{https://github.com/open-gitops/documents/blob/main/authors.md}. Release version 1.1.0}, + note = {Accessed: YYYY-MM-DD. For an up-to-date list of authors, see \url{https://github.com/open-gitops/documents/blob/v1.1.0/authors.md}. Release version 1.1.0}, year = {2024} } ``` \ No newline at end of file From 747bfc5836bdf76cf484a311120ee6d15c8823c1 Mon Sep 17 00:00:00 2001 From: Samuel Tauil Date: Thu, 8 Aug 2024 16:16:25 -0400 Subject: [PATCH 06/10] Release version disclaimer fix Signed-off-by: Samuel Tauil --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 381df45..67502d9 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ The OpenGitOps community follows the [CNCF Code of Conduct](https://github.com/o ## Reference this Content -A [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository is listed below, make sure to change your site visit date accordinly. +A [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository is listed below, make sure to change your site visit date, and optionally release version, accordingly. ``` @misc{open_gitops, From a1c311d0c2184ab07ac2339ae855332beb3278ca Mon Sep 17 00:00:00 2001 From: Samuel Tauil Date: Fri, 9 Aug 2024 09:44:08 -0400 Subject: [PATCH 07/10] Move REFERENCES to project repo Signed-off-by: Samuel Tauil --- REFERENCES.md | 87 --------------------------------------------------- 1 file changed, 87 deletions(-) delete mode 100644 REFERENCES.md diff --git a/REFERENCES.md b/REFERENCES.md deleted file mode 100644 index 934da06..0000000 --- a/REFERENCES.md +++ /dev/null @@ -1,87 +0,0 @@ -# Reference Material - -The reference material entries listed in this document are contributions covering GitOps principles and related topics. They do not constitute endorsements or affiliations with any specific tools, solutions, or companies mentioned in these documents. The inclusion of references is purely for academic or informational purposes to support understanding and research in the field of GitOps. If you want to include any related material please submit a PR. - -## Categories of GitOps Materials - -1. **Books** - - Comprehensive guides or textbooks covering GitOps principles, practices, and implementations. - -2. **Research Papers** - - Academic papers exploring various aspects of GitOps, including methodologies, comparisons with other DevOps practices, and empirical research. - -3. **Articles** - - Online or print articles discussing specific aspects of GitOps, such as tutorials, best practices, tool comparisons, and industry trends. - -4. **Documentation** - - Official or community-contributed documentation for GitOps tools, platforms, and frameworks, providing guidance on installation, configuration, and usage. - -5. **Case Studies** - - Real-world examples and case studies showcasing organizations' experiences and benefits of implementing GitOps practices in different environments. - -6. **Videos and Webinars** - - Recorded talks, presentations, or webinars discussing GitOps concepts, tool demonstrations, case studies, and expert interviews. - -7. **Tutorials and Guides** - - Step-by-step tutorials, guides, or manuals providing instructions on how to implement specific GitOps practices, set up tools, or solve common challenges. - -8. **Courses and Training Materials** - - Online courses, workshops, or training materials offering structured learning paths, certifications, and hands-on exercises focused on GitOps concepts and tools. - - -## Books - -| Book Name | Authors | Published Date | Publisher | ISBN | -|-----------------------------------|------------------|----------------|-----------------|----------------| -| *GitOps and Kubernetes* | Billy Yuen, Alexander Matyushentsev, Todd Ekenstam and Jesse Suen | February 2021 | Manning | 9781617297274 | -| *GitOps Cookbook* | Natale Vinto and Alex Soto Bueno | January 2023 | O'Reilly Media, Inc | 9781492097471 | -| *GitOps: Cloud-native Continuous Deployment* | Anja Kammer, Florian Beetz and Simon Harrer | July 2021 | Innoq Deutschland Gmbh | 9783982112688 | -| *Repeatability, Reliability, and Scalability through GitOps: Continuous delivery and deployment codified* | Bryan Feuling | May 2021 | Packt | 9781801077798 | -| *Practical Gitops: Infrastructure Management Using Terraform, Aws, and Github Actions* | Rohit Salecha | December 2022 | Apress | 9781484286722 | - -## Research Papers - -| Paper Title | Authors | Journal/Conference | Year | DOI/URL | -|-----------------------------------|------------------|--------------------|------|-------------------------| -| *Prevalence of GitOps, DevOps in Fast CI/CD Cycles* | Saumya Gupta, Madhulika Bhatia, Meenakshi Memoria and Preeti Manani | *2022 International Conference on Machine Learning, Big Data, Cloud and Parallel Computing (COM-IT-CON)* | 2022 | https://doi.org/10.1109/COM-IT-CON54601.2022.9850786 | -| *GitOps: The Evolution of DevOps?* | Florian Beetz and Simon Harrer | *IEEE Software ( Volume: 39, Issue: 4, July-Aug. 2022)* | 2022 | https://doi.org/10.1109/MS.2021.3119106 | -| *Continuous Deployment in IoT Edge Computing : A GitOps implementation* | Ramón López-Viana, Jessica Díaz and Jorge E. Pérez | *2022 17th Iberian Conference on Information Systems and Technologies (CISTI)* | 2022 | https://doi.org/10.23919/CISTI54924.2022.9820108 | -| *Analysis on the Use of Declarative and Pull-based Deployment Models on GitOps Using Argo CD* | Ramadoni, Ema Utami and Hanif Al Fatta | *2021 4th International Conference on Information and Communications Technology (ICOIACT)* | 2021 | https://doi.org/10.1109/ICOIACT53268.2021.9563984 | -| *Implementing DevOps Practices in CPPS Using Microservices and GitOps* | István Koren, Felix Rinker, Kristof Meixner, Moritz Kröger and Michael Zeng | *2023 IEEE 28th International Conference on Emerging Technologies and Factory Automation (ETFA)* | 2023 | https://doi.org/10.1109/ETFA54631.2023.10275433 | - -## Articles - -| Article Title | Authors | Publication Date | Source | URL | -|-----------------------------------|------------------|------------------|----------------|-------------------------| -| | | | | | - -## Documentation - -| Document Title | Authors/Contributors | Version | Date Updated | Source/URL | -|-----------------------------------|----------------------|---------|--------------|--------------------------| -| | | | | | - -## Case Studies - -| Case Study Title | Organization | Date Published | Industry | Description/Summary | -|-----------------------------------|------------------|----------------|----------------|--------------------------| -| | | | | | - -## Video and Webinars - -| Video/Webinar Title | Speaker(s) | Date Recorded | Platform | URL | -|-----------------------------------|------------------|-----------------|----------------|-------------------------| -| | | | | | - -## Tutorials and Guides - -| Tutorial/Guide Title | Author(s) | Date Published | Platform | URL | -|-----------------------------------|------------------|-----------------|----------------|-------------------------| -| | | | | | - -## Courses and Training Materials - -| Course/Training Title | Provider | Date Released | Format | URL | -|-----------------------------------|------------------|-----------------|----------------|-------------------------| -| | | | | | - From f7609a0fa3ca5d0e9ec4fe05366e4d0f0368a0c9 Mon Sep 17 00:00:00 2001 From: Samuel Tauil Date: Mon, 12 Aug 2024 20:45:04 -0400 Subject: [PATCH 08/10] Update README.md Co-authored-by: Scott Rigby Signed-off-by: Samuel Tauil --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 67502d9..492b9d5 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,26 @@ The OpenGitOps community follows the [CNCF Code of Conduct](https://github.com/o ## Reference this Content -A [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository is listed below, make sure to change your site visit date, and optionally release version, accordingly. +Below is a [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository. There is one required change, and several optional adjustments you may make to the snippet. + +Required: +- at minimum you will need to change the `Accessed` date (when you accessed this material) in the [note](https://www.bibtex.com/f/note-field/) field. + +Optional: You may choose to reference a different release version. If so: +- Change the `Release version` in the [note](https://www.bibtex.com/f/note-field/) field. +- Update the [year](https://www.bibtex.com/f/year-field/) field to match. See list of releases by date [here](https://github.com/open-gitops/documents/releases). +- Update the file link in `Authors` in the [note](https://www.bibtex.com/f/note-field/) field. You may find the list of authors by your chosen release version in the [reference](https://github.com/open-gitops/documents/blob/main/reference/) directory in this Git repo. + +Optional: You may reference multiple versions in the same article. If so: +- Update the [CiteKey](https://www.bibtex.com/g/bibtex-format/#citekey) below ("GitOps-Principles-and-Glossary") so each is unique (for example, append the version "-v1.0.0"). +- ⚠️ Note that the GitOps Principles and Glossary are versioned together, so when citing an individual principle and glossary item, ensure the versions match. This is because the two files have hyperlinks from one to the other that may be incorrect or broken between different versions. ``` -@misc{open_gitops, +@misc{GitOps-Principles-and-Glossary, title = {{GitOps Principles and Glossary}}, howpublished = {\url{https://github.com/open-gitops/documents}}, - note = {Accessed: YYYY-MM-DD. For an up-to-date list of authors, see \url{https://github.com/open-gitops/documents/blob/v1.1.0/authors.md}. Release version 1.1.0}, - year = {2024} + note = {Accessed: YYYY-MM-DD. Release version: 1.0.0. Authors: \url{https://github.com/open-gitops/documents/blob/main/reference/authors-v1.0.0.md}.}, + year = {2021} +``` } ``` \ No newline at end of file From 201158fdbfd16529073d98b4f80276a7d246fd63 Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Tue, 13 Aug 2024 17:51:54 -0400 Subject: [PATCH 09/10] remove gh code suggestion glitch Signed-off-by: Scott Rigby --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 492b9d5..7255571 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,5 @@ Optional: You may reference multiple versions in the same article. If so: howpublished = {\url{https://github.com/open-gitops/documents}}, note = {Accessed: YYYY-MM-DD. Release version: 1.0.0. Authors: \url{https://github.com/open-gitops/documents/blob/main/reference/authors-v1.0.0.md}.}, year = {2021} -``` } ``` \ No newline at end of file From 367e2336238bcf5d3853d35dfa2c95f0de7ea006 Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Tue, 13 Aug 2024 17:55:53 -0400 Subject: [PATCH 10/10] Deleting manual authors.md in favor of generated file in #82 See https://github.com/open-gitops/documents/pull/82 Signed-off-by: Scott Rigby --- authors.md | 41 ----------------------------------------- 1 file changed, 41 deletions(-) delete mode 100644 authors.md diff --git a/authors.md b/authors.md deleted file mode 100644 index 5f87167..0000000 --- a/authors.md +++ /dev/null @@ -1,41 +0,0 @@ -# Authors - -This is an up to date list of contributors. Thanks to all participants and contributors so far. - -Co-authored-by: Andrew Block ablock@redhat.com -Co-authored-by: Shoubhik Bose shbose@redhat.com -Co-authored-by: Kevin Bowersox kmb385@gmail.com -Co-authored-by: Michael Bridgen mikeb@squaremobius.net -Co-authored-by: Jesse Butler butlerjl@amazon.com -Co-authored-by: William Caban william.caban@gmail.com -Co-authored-by: Lloyd Chang lloydchang@gmail.com -Co-authored-by: William Chia thewilliamchia@gmail.com -Co-authored-by: Cornelia Davis ornelia@corneliadavis.com -Co-authored-by: Brice Fernandes brice@weave.works -Co-authored-by: Robert A Ficcaglia rficcaglia@users.noreply.github.com -Co-authored-by: Brian Fox brian@midnite-it.se -Co-authored-by: Dan Garfield dan@todaywasawesome.com -Co-authored-by: Christian Hernandez christian@redhat.com -Co-authored-by: John Hession johhess@cdw.com -Co-authored-by: Florian Heubeck Heubeck@mediamarktsaturn.com -Co-authored-by: Moshe Immerman moshe@flanksource.com -Co-authored-by: Cansu Kavılı Örnek ckavili@redhat.com -Co-authored-by: Timothy Lin timothylin@deloitte.com -Co-authored-by: Toni Menzel toni.menzel@rebaze.com -Co-authored-by: Leonardo Murillo leonardo@weave.works -Co-authored-by: Piotr decoder@live.de -Co-authored-by: John Pitman jpitman@redhat.com -Co-authored-by: Scott Rigby scott@r6by.com -Co-authored-by: Chris Sanders csand@microsoft.com -Co-authored-by: Carlos Santana csantana@us.ibm.com -Co-authored-by: Schlomo Schapiro schlomo@schapiro.org -Co-authored-by: Lothar Schulz mail@lotharschulz.info -Co-authored-by: Regina Scott rescott@redhat.com -Co-authored-by: Ishita Sequeira isequeir@redhat.com -Co-authored-by: Chris Short chris@chrisshort.net -Co-authored-by: Roberth Strand me@robstr.dev -Co-authored-by: Sean Sundberg seansund@us.ibm.com -Co-authored-by: Nicholas Thomson RedbackThomson@users.noreply.github.com -Co-authored-by: Daniel Warner daniel.warner@codefresh.io -Co-authored-by: Kingdon Barrett kingdon+github@tuesdaystudios.com -Co-authored-by: Samuel Tauil samueltauil@gmail.com \ No newline at end of file