Performed in 2019, the below is a census of what documentation exists, where it lives at the time of the census, and its condition (up to date, out of date, etc).
The most visible entry point for documentation is the "Documentation" navigation entry on https://tungsten.io/, which directs the user to https://tungstenfabric.github.io/website/.
On the https://tungstenfabric.github.io/website/ site, there are the following components:
- Getting started with:
- AWS - This is the 'Carbide' project.
- Will Stevens : I have not had a chance to validate this process.
- CentOS
- Will Stevens : I have spent quite a bit of time testing this process. However, the manifest that is used in this process does not seem to be tied to the currently maintained manifest process. It is unclear if the manifests documented in this process is maintained.
- Ubuntu
- Will Stevens : I have not tested this process, but it is very similar to the CentOS process above. Again, it is unclear if the manifest associated with this recipe is maintained, as it does not seem to be associated with the currently maintained manifest process.
- OpenStack
- Will Stevens : I have not tested this process. It is based on the Ansible Deployer.
- AWS - This is the 'Carbide' project.
- Deployment option not represented at the top level on this page:
- Ansible Deployer for Kubernetes
- Will Stevens : I have not had a chance to test this process yet, but I believe it should be added as a top level deployment option.
- tungstenfabric/tf-devstack
- Will Stevens : I have not had a chance to test this process yet, but I believe it should be added as a top level deployment option.
- Gary Greenberg would you be willing to add some sub-points to this section to provide some details on the experience of using `tf-devstack` and potentially document issues you feel should be addressed?
- tungstenfabric/tf-dev-env
- Will Stevens : I have no experience with this repo. I am unclear to me how this repo compares with the `tungstenfabric/tf-devstack` and which should be the preferred dev environment. It is worth pointing out that this repo is a fork of the juniper/contrail-dev-env repo. It is unclear how these repos are maintained and what support the user can expect when using these repositories. From what I can tell, the juniper/contrail-dev-env repository was used to build the actual release. What is the plan for these repositories?
- Ansible Deployer for Kubernetes
- Becoming a contributor:
- In general, the details on this page are very focused on the process to contribute to the Juniper repositories and their Gerrit (https://review.opencontrail.org). Given the fact that the actual code repos are still in Juniper, it is painfully confusing what should be documented for contributing to the code today. We have a mix of both Juniper specific details and Tungsten Fabric assets on this page, and it is extremely unclear what is relevant and what is not.
- I (Will Stevens) recommend that we clearly call out the fact that the code is in the process of moving and the process and location of the different assets and processes associated with them are documented separately.
- Current code location, OpenContrail (Juniper Repos)
- Code managed in Gerrit at: https://review.opencontrail.org
- CLA for contribution is at: https://review.opencontrail.org/#/settings/agreements
- Target code location, Tungsten Fabric (LF Repos)
- Code managed in Gerrit at: https://gerrit.tungsten.io
- CLA for contribution is at: https://gerrit.tungsten.io/r/settings/ (Navigate to Agreements)
- Community Jira: https://jira.tungsten.io
- Community Wiki: https://wiki.tungsten.io/
- Current code location, OpenContrail (Juniper Repos)
Work In Progress... I will continue when I have more time...