cdevents / community Goto Github PK

From @afrittoli amazing presentation at CD Con 2023, a general discussion began around having a tool for visualizing the CD Events data. From the presentation, Andrea's architecture contained a layer after the data brokers for the end user to store, visualize and perform analysis on the CD Events data. I wanted to start a discussion around this capability and what open source tools that may already exist we could leverage.

For this first iteration, I think we should primarily focus on the storage and visualization of the data. Here are a few initial thoughts:

1. The storage and data visualization should be IaC that can easily have swappable parts. For example, if someone wants to deploy this capability to AWS they could opt to use S3.
2. We should try to use an CNCF project, if one exists (I'll start digging later this week), for the visualization to help promote another projects. We may need to create our own visualization depending on how customizable end users will want to make the dashboard.

Will continue to add more but Fatih wanted me to start the initial post before I forgot! 😆

In order for CD Foundation to support the project properly and make insights available for the project on LFX, the user thelinuxfoundation must be invited to the GitHub CDEvents Organization.

Please invite the user thelinuxfoundation as an owner at the organization level (not per repository) to the GitHub organization.

Expand on https://github.com/afrittoli/cdeventer or build something different?

In the old sig-events repo we used GitHub Discussions. Should we keep doing that in the cdevents org? If so, should we keep all such discussions in one repo (this one?) or separate spec discussion from other discussions and thereby support Discussions in multiple repos under cdevents?

Implement a proof of concept to collect the four DORA metrics through CDEvents.

• Planning document: https://hackmd.io/cFw0xO6XSwGwIoJ78Re91A

• Collaborate with the 4-keys team at Google @davidstanke

• cdCon talk: https://sched.co/10UYC

• Make sure all issues are resolved: https://github.com/cdevents/spec/milestone/4
• Switch all versions from 0.4.0-draft to 0.4.0 cdevents/spec#199
• Switch all event versions from version-draft to version cdevents/spec#199
• Remove mentions of draft / work-in-progress content cdevents/spec#199
• Update the README to mention 0.4.0 as latest release cdevents/spec#201
• Tag spec and create branch for patch releases https://github.com/cdevents/spec/releases/tag/v0.4.0
• Produce release notes through GitHub https://github.com/cdevents/spec/releases/tag/v0.4.0
• Update cdevents.dev as needed cdevents/cdevents.dev#42
• Prepare a release announcement for v0.4 (see #47 for reference) - draft
• Announce release on slack and mailing list
• Move main in the spec repo to the new -draft release cdevents/spec#203
• Updates the SDKs
  • Golang
  • Java
  • Rust
  • Python

Evaluate if it's possible to use Postee in conjunction with CDEvents, and build a small POC (code/script + README)

Good first issue

In the license file on line 189 the authors haven't been stated, this is a common thing that people miss when adding apache2 licenses.

replace the text with:

Copyright 2023 The cdevents Authors

This is a placeholder for the idea of creating a PoC for integrating CDEvents with GitHub Actions.

One way to showcase it could be according to an “Iteratively expanding CI/CD System”, for example:

• Initially just a GitHub Actions pipeline, with a set of consumers (e.g. deployer, visualizer, DORA calculator, raw event viewer)
• Secondly break out the pipeline execution to a Tekton pipeline, with no change to the consumers
• Thirdly break out test activities from Tekton pipeline to Testkube, with no change to the consumers

/cc @bradmccoydev

Pick one of the SDKs and develop a CLI for it which allows terminal users and scripts to send events without directly integrating with any of the SDKs.

The Go SDK used to have a CLI (so did the Python SDK) but in their current version none of the SDKs provide a CLI.

Go SDK tends to be faster with adopting new spec changes, but may be slightly trickier to build and distribute?
Python SDK can come with a CLI that can be distributed via pypi, but it won't be much value if it is often out-of-date.

Thoughts and ideas?

• Make sure all issues are resolved: https://github.com/cdevents/spec/milestone/3
• Switch all versions from 0.2.0-draft to 0.2.0 cdevents/spec#131
• Switch all event versions from version-draft to version cdevents/spec#131
• Remove mentions of draft / work-in-progress content cdevents/spec#131
• Update the README to mention 0.2.0 as latest release cdevents/spec#133
• Tag spec and create branch for patch releases
• Produce release notes through GitHub
• Update cdevents.dev as needed cdevents/cdevents.dev#35
• Prepare a release announcement for v0.3 (see #47 for reference)
• Announce release on slack and mailing list
• Move main in the spec repo to the new -draft release cdevents/spec#135

Implement the RFC at spinnaker/governance#299

This needs to be added to the requirements for SDK #4.

This issue tracks the work in the various SDKs:

• golang
• java
• python

This issue is to receive nominations for the CDEvents Most Valuable Contributor (MVC) Award 2023 for CDF.

This award recognizes excellence of contributions to the CDEvents project, which may be any or a combination of contributions to the specification, work on the SDKs, implementation of proofs of concepts, advocacy and fostering adoption in other communities.

To nominate someone, reply to this issue with the following:

Full name of the person you’re nominating
Short description of their contributions to the CDEvents project and why they should win.
Nomination Deadline: Tuesday, March 3 2023

Voting will be done through a Google form once the nomination period has ended

More details are available here: https://github.com/cdfoundation/foundation/blob/main/CDF%20Awards%20Guidelines.md#project-awards

Hacktoberfest 2022

Hacktoberfest is a month-long celebration of open source software. It happens every year in October. During this event, everyone can support open-source by contributing changes and then earn limited edition swag.

The CDEvents project is happy to participate in Hacktoberfest for the first time - we're a new project and exciting project and we very much welcome contribution.

Where to contribute

We prepared an Hacktoberfest GitHub project to group all the issues to make it easier to discover them.

SDKs

Most of the work is on SDKs, and the good news is that this gives a lot of different options in terms of development language of choice: golang, python, java, javascript and rust are the ones we are considering now, but we're happy o accept proposals about other languages.

Website

Our website may use some love too. We have one issue created for the website about hosting the schemas.
There's more to be done: testing mobile usability of the website, making information about the community more easily discoverable and other ideas are welcome.

Getting involved

See our community page about how to join our slack and mailing list.
Feel free to comment on an issue you would like to work on, join slack and say hello, we're here to help.

Note: Before you start contributing, you must read and abide by our Code of Conduct. See our contributing guidelines for more details.

This is a proposal to implement a PoC for CDEvents that also uses an "evidence store" to subscribe to aggregated date from multiple events

At CDCon 2023 the community had a discussion around the fact that there should be a reference implementation or a "way to demonstrate" cloud events.

A few different technologies were discussed (I apologise but can't remember the names of the attendees) - but the overarching impression I was left with was that the CDEvents project needs some way (beyond the spec) to actually show how CDEvents can be used in a hands-on, practical demo.

This issue covers the creation of such a demo system.

Important to note that whatever tools / tech is used in this system, we should make clear that CDEvents is tool agnostic and so the tooling is purely an example. The user ultimately must choose the correct tooling for their use case and circumstances.

Please assign to me as I'm happy to work on this.

CDEvents has two POCs in https://github.com/cdfoundation/sig-events/tree/main/poc.
Those two POCs:

• are hosted in the sig-events repo
• use an old version of the golang SDK
• have somewhat sparse documentation
• are not discoverable through cdevents.dev

This issue is about fixing all these.
It would be ok to split it in sub-issues if needed.

From the CDEvent WG meeting on 06 Sept 2022, we discussed general features required by SDKs

• Unit test coverage
• Conformance tests (hosted in the spec/jsonschema?)
• Pin the spec version in the SDK

Currently the CDEvents project is governed by CDF SIG Events. A proper project/community setup should be planned for, with a technical committee. SIG Events will serve as bootstrap technical committee until a new one is in place.

DoD: Plan for setting up the governance exists on GitHub

We do not have a C# SDK yet. We are looking to create one, which would be multiple task

• Setup the structure of the repo
• Define the interface in rust idiomatic format
• Create the base framework, with tests
• Setup CI using GitHub actions
• Add events to the SDK (can be one or more events per PR)

Hacktoberfest 2023

Hacktoberfest is a month-long celebration of open source software. It happens every year in October. During this event, everyone can support open-source by contributing changes and then earn limited edition swag.

The CDEvents project is happy to participate in Hacktoberfest - we're a fairly new and exciting project and we very much welcome contribution.

Where to contribute

We prepared an Hacktoberfest GitHub project to group all the issues to make it easier to discover them.

SDKs

Most of the work is on SDKs, and the good news is that this gives a lot of different options in terms of development language of choice: golang, python, java, dotnet, javascript and rust are the ones we are considering now, but we're happy to accept proposals about other languages.

Getting involved

See our community page about how to join our slack and mailing list.
Feel free to comment on an issue you would like to work on, join slack and say hello, we're here to help.

Note: Before you start contributing, you must read and abide by our Code of Conduct. See our contributing guidelines for more details.

https://github.com/firestoned/firestone

Planning item, this will require work on the spec, SDKs, and website.

Document what entails making a new release for CDEvents.
Some aspects to consider:

• versioning of the spec
• planning and aligning SDKs
• updates to examples and POCs
• website documentation
• announcements, blog posts etc

In the last CDEvents working group meet up, I suggested creating a FAQ, "Frequently Asked Questions", page.

A FAQ page can be a good landing spot for people who are unfamiliar with CDEvents. It can also hold information that does not fit neatly into other technical docs or the whitepaper.

Some sample questions:

• When will the next version of CDEvents be published?
• How does CDEvents deal with private data?
• I want to update the spec with new data. What should I do?

To try to minimize duplication, we can refer to existing docs, whitepaper, or github issues.

I propose we start by creating a new document, "faq.md", in this repository.

If we find this page has valuable content, we can then update either the documentation or community sites with links to this faq page.

We do not have a Javascript SDK yet. We are looking to create one, which would be multiple task

• Setup the structure of the repo
• Define the interface in javascript idiomatic format
• Create the base framework, with tests
• Setup CI using GitHub actions
• Add events to the SDK (can be one or more events per PR)

We do not have a Rust SDK yet. We are looking to create one, which would be multiple task

• Setup the structure of the repo
• Define the interface in rust idiomatic format
• Create the base framework, with tests
• Setup CI using GitHub actions
• Add events to the SDK (can be one or more events per PR)

In the SIG Events repo we started to use the wiki feature of GitHub. Should we do that somewhere in the cdevents org as well? If so, in what repo(s)?

KLT wraps the Kubernetes scheduler and can trigger arbitrary tasks before and after a pod is scheduled.

This issue covers the creation of a template KeptnTaskDefinition that emits a CDevent.

This issue is to receive nominations for the CDEvents Most Valuable Contributor (MVC) Award 2024 for CDF.

This award recognizes excellence of contributions to the CDEvents project, which may be any or a combination of contributions to the specification, work on the SDKs, implementation of proofs of concepts, advocacy and fostering adoption in other communities.

To nominate someone, reply to this issue with the following:

• Full name of the person you’re nominating
• Short description of their contributions to the CDEvents project and why they should win.

Nomination deadline: Sunday, February 19, 2024 at 11:59 PST
Please note: Last year's winner, Emil Bäckmark, cannot win the award for CDEvents MVC again this year.

CDF Project Awards Guidelines

Other CDF Community Awards for 2024

We don't have any guidelines for what roles to use for maintainers of the repos in CDEvents, and it varies from repo to repo.

Role descriptions: https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization

Just noticed that the current calendar links go to here:

Is this meant to a placeholder or should it match up with the links in the other repos ? Happy to open a PR if so.

Reach community consensus on the Spinnaker RFC: spinnaker/governance#299

It could be based on our of our previously held CDEvents intros used in various conferences.