From 7e8775405e73eb42da1a979228454a7311ef1d25 Mon Sep 17 00:00:00 2001 From: Mark Sanders Date: Thu, 7 Sep 2023 18:11:14 -0500 Subject: [PATCH] docs(general): minutes and API template Signed-off-by: Mark Sanders --- doc/TEMPLATE.md | 33 +++++++++++++ doc/minutes/Minutes-Topics-August-2023.md | 57 +++++++++++++++++++++++ doc/minutes/Minutes-Topics-Sept-2023.md | 55 ++++++++++++++++++++++ 3 files changed, 145 insertions(+) create mode 100644 doc/TEMPLATE.md create mode 100644 doc/minutes/Minutes-Topics-Sept-2023.md diff --git a/doc/TEMPLATE.md b/doc/TEMPLATE.md new file mode 100644 index 00000000..3e5755d9 --- /dev/null +++ b/doc/TEMPLATE.md @@ -0,0 +1,33 @@ +# TEMPLATE (Name of API) API + +High Level Description of the API in this area. + +## Reference Implementations + +Include reference implementations in this section + +_All implementations herein above are for reference only and __not__ meant to be used as-is in production_ + +## Clients + +The available clients for the API are: +see and for clients + +(_The API implementation should add support in the clients for the interface though both clients may not have the support at the same time_) + +## Demos + +Include references to any demos in this section + +## Additional Information related to the API + +Include topic areas such as below (These would become headings in this documentation section). Replace this section header with the Header(s) for the additions that are being added: + +- Use Case Examples + - Use Case #1 + - Use Case #2 +- Implementation/Architecture/Infrastructure View of API +- Provisioning Aspects +- Pipeline Flow of relationships +- Management Aspects +- References diff --git a/doc/minutes/Minutes-Topics-August-2023.md b/doc/minutes/Minutes-Topics-August-2023.md index 9298f6be..8e878fa7 100644 --- a/doc/minutes/Minutes-Topics-August-2023.md +++ b/doc/minutes/Minutes-Topics-August-2023.md @@ -11,3 +11,60 @@ Topics Covered: Recording at: --- + +## August 10 + +Canceled - No topics and many conflicts with summer vacations + +--- + +## August 17 + +Topics Covered: + +- Capabilities Advertisement from the DPU/IPU + +Notes: + +- Think about how/what should be contained in a "Capabilities Advertisement" API message for the DPU to include the Platform (HW) and Software capabilities. Some of the things to consider: + - Utilize the NetConf capabilities advertisement mechanism and how that would map + - Review the Cloud API Capabilities that is contributed and align/expand + - Include the view on Netlink models and how it advertises capabilities. +- We are planning to have a Network API workshop in the September timeframe. + - Please provide any suggestions related to the timing. + - From the earlier poll it seemed a Tuesday would work best. + - Also, the workshop(s) will be limited to 2 hours with 1 or more planned to work though the concept of API framework and what should be in the API. The API needs to consider how the initial configuration is put in place (Day 0) and then how changes are made to the configuration over time (Day N+) + +Recording at: + +--- + +## August 24 + +Topics Covered: + +- Netlink and YNL work from Redhat - Donald Hunter + +Recording at: + +--- + +## August 31 + +Topics Covered: + +- Discuss Pull Request #343 +- API versioning bumping - when to change the version number +- Close EVPN GW open questions + +Notes: + +- Proposal for version changes to be made to the TSC for approval. + - Companies need to buy-in and agree to the proposal. + - Proposal will be done in a .md file for review. +- EVPN Gateway needs to have a persistence layer database. REDIS and/or Badger are proposed + - Pub/Sub model needs to be identified + - Implementation meeting is needed. This probably should be taken up by the PoC Team (which looks to be defunct currently) + - This needs to be taken up by the TSC. + +Recording at: diff --git a/doc/minutes/Minutes-Topics-Sept-2023.md b/doc/minutes/Minutes-Topics-Sept-2023.md new file mode 100644 index 00000000..a407bc13 --- /dev/null +++ b/doc/minutes/Minutes-Topics-Sept-2023.md @@ -0,0 +1,55 @@ +# Minutes/Topics September 2023 + +--- + +## Sept 7 + +Topics Covered: + +- Discuss PR#343 - Still pending +- Discuss Announcements on API changes for checking and linter +- Networking Workshop Timing Planning +- Review Issues and Pending PRs in Github +- Documentation for API areas (Template needed) +- Requirements for moving APIs from Alpha to Beta + +Notes: + +- Alignment to Google AIP - objects need name field and string + - Name enforcement, and name field can't be set by the customer unless it is not generated by the system. + - Change from output only to IDENTIFIER +- API Networking Workgroup - In Person - September + - Week of Sept 18th - Start at 8:00am PT to accomodate EU and other timezones as much as possible + - Agenda for meeting to propose +- Documentation Template view for API definitions + - Github.com/opiproject/opi-api/tree/main/storage as an initial example + - API Template needs to have common look and feel with area for details to be added + - Open an issue for Template Format of Documentation - Complete +- Requirements for moving Alpha APIs to Beta view - Need a PR for putting that together. + - Open an issue for API transitions - Complete +- Completed PR review - cleaned up several older items. +- Issues review + - Several need to be in discussion topics. Specifically: + - #53 + - #142 + - #211 + - #323 + - #332 needs to be taken up with the protoc-gen-grpc-gateway community + - We need people to take up issues and have them assigned to them to address. + - Use the github discussions to work through various issues in collaborative environment along with slack channel. + +Recording at: + +--- + +## Sept 14 + +Topics Planned: + +- Discuss PR#343 - Still pending. + +Notes: + +Recording at: + +---