- Review the Project Lifecycle to get a clear picture of how projects work within ODIM.
- Create a new Page from this template: Create from Project template
- Fill in the page you created describing your proposal.
- Please indicate if you are planning to contribute existing code, or start a new project from scratch.
- Note: It is very important that you include LF ID and associated email address for all initial committers. This will speed the on-boarding process immensely.
- Send mail to tsc with a reference to your newly created project proposal page
- Prepare your existing code for contribution. Suggestions can be found here.
- If you are importing code, submit your code to the Linux Foundation for IPR Review by contacting Casey Cain .
Guidelines for Creation Review
The last step before your project is formally created is to have a creation review (See section 2.3.1 of the Project Lifecycle) during a TSC meeting.
- You can ask for your creation review to be scheduled for any TSC meeting that is more than two weeks after the proposal was e-mailed to the tsc list.
- Please e-mail the tsc list to schedule the Creation Review.
- It may not be possible to schedule the creation review on the requested day, the TSC does it's best to accommodate requests.
- Creation reviews typically last 20–30 minutes.
- People usually either bring slides or just use their proposal if it goes into sufficient detail.
- A few diagrams of the major components and how they interact are often useful.
- If you plan to use slides, please upload them to the wiki ahead of time so that people can see them without needing Zoom screensharing to work as it's often annoying to get to work on Linux.
- Common questions that come up are:
- Is the committer list complete?
- What problem is being solved here? What is the scope of the project?
- How should we expect it to interact with other related components and projects that are already in ODL?
- How would a user interact with it? any user story to illustrate?
Guidelines for After Creation Review
Once your project has been formally approved by the TSC, you'll want to start getting it set up.
- Move your approved project page to the "Approved Projects" section of the wiki,
- Update the approved projects main page table with::
- a link to your project
- a quick description
- @<tag> for the PTL of the project
- Update the approved projects main page table with::
- Make sure any code you are bringing in goes through IPR Review by contacting Casey Cain.
- Look at the New Project Checklist
- Of particular note, create a wiki page for your project using the Project Template so that people can find key information about your project and so that it appears in the Project list.
- The first thing you'll want to do is to open a ticket at support.linuxfoundation.org with a link to the TSC minutes (or TSC list e-mail) showing your creation review approval asking for your resources to be set up.
- After that, you should start working through the tasks on the checklist.
- At the very least, you can set up your main project wiki page with the key facts while your infrastructure is being set up.
Guidelines for New Projects
New Projects Checklist
This is a page where we store proposals that we want the TSC to take a look at
|Proposal||Summary||Comments||TSC Comments||Approval State|
|Update Service||Implementation of the Redfish Update Service as specified in 2020.2 release||Initially only the SimpleUpdate action will be supported|
|Plugin for Unmanaged Racks||A plugin that emulates resource managers for unmanaged racks|
This is needed to support a physical view of the data center. Things like:
|Composition Service||Implementation of Composition Service||Redfish Composition service development in ODIM|
A new proposal added.
JSON samples added for POST resource block.
|BMC Simulator||Implementation of Redfish based REST server exposing BMC interface compliant with Redfish schema||Data model exposed by BMC simulator will be compliant with OCP server profiles as well as with OPAS Redfish profile.||See Mom|
|Dell Server Community Plugin||Open Source plugin to manage Dell Servers.||Start with Generic Redfish Plugin. Add mapping to populate properties mandated by the upcoming ODIM profiles. Support of events and local storage are high wants||TSC in favor. See MoM|
|Cisco APIC controller Plugin||Open source plugin to manage Cisco ACI data center switching||Building an open source plugin to Cisco APIC will enable the joint management of compute as well as networking through standards based Redfish APIs. This is something that doesn't exist in the industry today but will be critical to support lights out operations of data centers||We will push this vote out till we have a document describing the mapping.|
|LFN Demo: 5G Cloud Native Network|
Determine potential to implement ODIM on one or more sites/cores.
The LFN Demo team is targeting ONES 2021 North America, October 11-12, 2021, for an updated 5G Cloud Native Demo. There is potential for ODIM to be included. Factors:
|Telemetry Service||Implementation of the Telemetry Service as specified in 2020.3 release.||The first implementation would be to expose vendors' metric reports and to allow clients to subscribe to those. To move further we need more discussions|
|Open Source plugin to manage Lenovo Servers.||Start with Generic Redfish Plugin. Add mapping to populate properties mandated by the upcoming ODIM profiles. Support of events and local storage are high wants||Approved to contribute this plugin|
Grpc is a rpc mechanism implemented by google. This uses http/2 with binary encoding for messages. There is also wide adaptation in the industry which will aid in integrations with third party products.
|Discuss on the implementation strategy and approach TSC architecture forum.|
|Properties for UpdateService||[Enhancement] Add missing properties for UpdateService||According to Open Process Automation Forum and their standard for Redfish profile (supporting document: https://www.opengroup.org/sites/default/files/pdf/O-PAS-OSM-002-v2_0_0.json) following properties are recommended to support, but missing in ODIM:|
HttpPushUriOptions, HttpPushUriOptionsBus, HttpPushUriTargets, HttpPushUriTargetsBusy, MaxImageSizeBytes, MultipartHttpPushUri.
|Support redis streams as alternative to Kafka bus||Add Redis streams as an alternative to Kafka||ODIM RA will add support for using Redis streams as a replacement to Kafka in constrained environments|
|Persist events in online DB during network outages||Persist unpublished events in redis for sending these to subscribers subsequently.||Network outages between ODIM RA and event subscriber results in loss of events. This proposal is to persist these events in redis for sending these to subscribers subsequently.|
|DMTF Profiles Proposal||Refine and integrate DMTF RF ODIM Profiles as a key component of ODIM and ODIM's CI/CD pipeline|
|Support for Redfish 2021.2 release||Support for new schemas available in the 2021.2 release of redfish spec.|
|Enhance logging in ODIM to use syslog format (as per RFC5424)||use RFC5424 format for ODIM logs.||log application/security logs using this format.||TSC in favor|
|Add IPv6 support to ODIMRA||Add IPv6 support to ODIM RA||TSC in favor|
|Add kubernetes operators to deploy/manage ODIMRA installations||Add kubernetes operators for deploying and managing ODIM||TSC in favor|
|Add support to Tasks from the plugin-ODIM interface.||Enable ODIM to handle Tasks Task Status received from plugin||TSC in favor|
|Move plugins out of ODIM-RA repository||Move the plugin to repositories out of ODIM-RA to different repositories|