Tungsten Fabric is an open source network virtualization solution for providing connectivity and security for virtual, containerized or bare-metal workloads.
Tungsten Fabric supports integrations with the following orchestrators:
Openstack Kubernetes Openshift vCenter BYOO [Bring your own orchestrator]
Start using Tungsten Fabric
Becoming a contributor
Whether you want to fix a typo in comments or introduce a brand new feature, there are a few steps which make the process smoother:
Create a Linux Foundation ID, if you don’t have one yet. You’ll need this to subscribe to the mailing lists and to access the bugs and blueprints.
The wiki currently contains legal and technical docs, event decks and similar resources to boost your understanding of Tungsten Fabric. This material will eventually be moving to the wiki or Git repositories.
Join Slack. Post your questions to relevant channels, don’t abuse @here, get help and help others. The mailing list works best for long-running discussions; Slack is great for ad-hoc conversations.
Before you push anything, you’ll need to sign a Contributor License Agreement or CLA: either Individual CLA (ICLA) if you are an independent contributor, or Corporate CLA (CCLA). We suggest you sign a CCLA if you are employed at a company which pays you for your Tungsten Fabric-related work. CCLA also simplifies things if your teammates plan to contribute as well. Both ICLA and CCLA are legal documents. Please read them carefully. It’s usually smart to run the document past your company’s legal department before signing and submitting it, if only to verify that your contribution will be within your company’s policy. You can find all ICLA/CCLA documents in the Tungsten Fabric CLA Wiki.
If you’ve found a bug, file a bug report against the respective release in Jira. Be sure to describe both expected and actual behavior. You’ll need the bug ID later, so please do this even if you feel the change is trivial.
- If you plan to develop a new feature, you must create or provide three things:
- A blueprint. A blueprint is a short piece of text describing which feature do you propose, why it is good to have it in Tungsten Fabric, and who will be developing it. Blueprints are very important as they are used to plan future releases of Tungsten Fabric.
- A detailed technical spec. Each blueprint should link to a more detailed technical specification document. These specifications must be submitted to the contrail-specs GitHub repository. They are not stored or tracked in Jira.
- A Jira bug ticket. While the blueprint briefly describes the work that will be done, the ticket is where the work actually happens (commits get linked to the ticket).
- Here is an example of a complete Jira blueprint.
- Although contrail-specs and other Tungsten Fabric repositories are hosted on GitHub, they are managed with Gerrit. Please don’t send Pull Requests to the GitHub repositories, and go to https://review.opencontrail.org instead. Blueprint specs are submitted this way as well.
Note that Tungsten Fabric is currently migrating from Juniper owned https://review.opencontrail.org to [https://github.com/tungstenfabric/] email email@example.com for the latest information.
- After getting Gerrit access as described below, clone the specs repository
with the command:
git clone https://review.opencontrail.org/Juniper/contrail-specsand install the git-review extension which will allow you to submit specs as well as code changes. In order to write a spec, start by copying the template
blueprint_template.mdto a meaningful name in the appropriate subdirectory for the release that you would like to target.
With all of these in place, you are now ready to submit your specs and code to Tungsten Fabric! How to write these specs and code is a different story though, but we hope the links in the next section will help you to get started. You may also want to consult a more detailed how-to available here, in the contrail-community-docs repo. And of course, feel free to ask questions on the mailing list and in Slack channels!
Start developing Tungsten Fabric
NOTE: The columns and dates below are subject to change. An effort is still underway to reconcile Tungsten Fabric processes and previously established Juniper practices with respect to Contrail development timelines.
|Release||Blueprint Due||Specification Due||Dev Complete||GA Release|
- Release: The numeric identifier of the release
- Blueprint Due: Tungsten Fabric currently uses Jira, so the blueprint due here refers to the Jira Blueprint which will be reviewed by the TSC for strategic alignment and release planning.
- Specification Due: The specification or “spec” is design document with section headings that should be filled in, or at least though about and decided to be non-applicable. Specs should be submitted as described earlier in this document.
- Dev Complete: This column may be considered synonymous with “feature freeze” and is intended to mark the transition from “new development” to “testing, debugging and making production-ready”.
- GA Release: This column is the target release date. Historically Contrail has usually missed release dates in order to finish incomplete features. Tungsten Fabric will attempt to move to a time based release model, but this is still under discussion.