From 6d6170481839d080cfd297a9563849bb47d4c95a Mon Sep 17 00:00:00 2001 From: Phu Tran <22720475+phudtran@users.noreply.github.com> Date: Sat, 4 Apr 2020 14:35:01 -0700 Subject: [PATCH] Added MIT License to documentation files --- docs/design/dp_datamodel.md | 23 ++++++++++++++++++- docs/design/dp_direct_path.md | 23 +++++++++++++++++++ docs/design/dp_extensibility.md | 23 +++++++++++++++++++ docs/design/dp_overview.md | 23 +++++++++++++++++++ docs/design/dp_programability.md | 23 +++++++++++++++++++ docs/design/dp_scaled_endpoint.md | 22 ++++++++++++++++++ docs/design/dp_tunneling_protocols.md | 22 ++++++++++++++++++ docs/design/mp_datamodel.md | 23 +++++++++++++++++++ docs/design/mp_dpsupport.md | 23 +++++++++++++++++++ docs/design/mp_ipam.md | 23 +++++++++++++++++++ docs/design/mp_overview.md | 23 +++++++++++++++++++ docs/design/mp_workflows.md | 23 +++++++++++++++++++ docs/design/puml/create_bouncer_workflow.puml | 21 +++++++++++++++++ docs/design/puml/create_divider_workflow.puml | 21 +++++++++++++++++ docs/design/puml/create_droplet_workflow.puml | 21 +++++++++++++++++ .../design/puml/create_endpoint_workflow.puml | 21 +++++++++++++++++ docs/design/puml/create_network_workflow.puml | 21 +++++++++++++++++ .../puml/create_scaled_endpoint_workflow.puml | 21 +++++++++++++++++ docs/design/puml/create_vpc_workflow.puml | 21 +++++++++++++++++ docs/design/puml/delete_bouncer_workflow.puml | 21 +++++++++++++++++ docs/design/puml/delete_divider_workflow.puml | 21 +++++++++++++++++ .../design/puml/delete_endpoint_workflow.puml | 21 +++++++++++++++++ docs/design/puml/delete_network_workflow.puml | 20 ++++++++++++++++ .../puml/delete_scaled_endpoint_workflow.puml | 21 +++++++++++++++++ docs/design/puml/delete_vpc_workflow.puml | 21 +++++++++++++++++ docs/design/puml/direct_path.puml | 22 ++++++++++++++++++ .../puml/direct_path_endpoint_deleted.puml | 22 ++++++++++++++++++ .../design/puml/direct_path_host_failure.puml | 21 +++++++++++++++++ .../puml/direct_path_inter_network.puml | 22 ++++++++++++++++++ .../puml/update_scaled_endpoint_workflow.puml | 21 +++++++++++++++++ docs/dev/contributing.md | 23 +++++++++++++++++++ docs/index.md | 23 +++++++++++++++++++ docs/releases/release-notes.md | 23 +++++++++++++++++++ docs/releases/roadmap.md | 23 +++++++++++++++++++ docs/releases/use_cases.md | 23 +++++++++++++++++++ docs/user/faq.md | 23 +++++++++++++++++++ docs/user/getting_started.md | 23 +++++++++++++++++++ 37 files changed, 814 insertions(+), 1 deletion(-) diff --git a/docs/design/dp_datamodel.md b/docs/design/dp_datamodel.md index da261285..bae1eed4 100644 --- a/docs/design/dp_datamodel.md +++ b/docs/design/dp_datamodel.md @@ -1,4 +1,25 @@ - + Mizar's data-plane adopts a simple data model that is essential to extend its functionality. The data-model is independant of the API definitions of the diff --git a/docs/design/dp_direct_path.md b/docs/design/dp_direct_path.md index eb1219c4..d71417a7 100644 --- a/docs/design/dp_direct_path.md +++ b/docs/design/dp_direct_path.md @@ -1,3 +1,26 @@ + + # Direct Path The direct path feature allows a flexible data-plane fast path that avoids diff --git a/docs/design/dp_extensibility.md b/docs/design/dp_extensibility.md index 960020b5..7a4dca47 100644 --- a/docs/design/dp_extensibility.md +++ b/docs/design/dp_extensibility.md @@ -1,3 +1,26 @@ + + Mizar facilitates the development of **Multi-tenant** networking functions at various levels of the stack. The multi-tenant features mainly include reuse of address space, traffic processing by the same functions, and traffic isolation diff --git a/docs/design/dp_overview.md b/docs/design/dp_overview.md index 5974d710..08264b15 100644 --- a/docs/design/dp_overview.md +++ b/docs/design/dp_overview.md @@ -1,3 +1,26 @@ + + Mizar's data-plane is the core engine behind its scalability, performance, and programmability. The data-plane is primarily a group of XDP programs. Before diving deep into how the data-plane works, we need to introduce the essential diff --git a/docs/design/dp_programability.md b/docs/design/dp_programability.md index d5c8c932..3f41d788 100644 --- a/docs/design/dp_programability.md +++ b/docs/design/dp_programability.md @@ -1,3 +1,26 @@ + + The data-plane supports an internal protocol to facilitate data-plane programming through remote RPC. Any management plane that would incorporate Mizar's data-plane shall use these programming interface. [Mizar diff --git a/docs/design/dp_scaled_endpoint.md b/docs/design/dp_scaled_endpoint.md index e69de29b..3821d39d 100644 --- a/docs/design/dp_scaled_endpoint.md +++ b/docs/design/dp_scaled_endpoint.md @@ -0,0 +1,22 @@ + \ No newline at end of file diff --git a/docs/design/dp_tunneling_protocols.md b/docs/design/dp_tunneling_protocols.md index e4b3863c..2c0db7d1 100644 --- a/docs/design/dp_tunneling_protocols.md +++ b/docs/design/dp_tunneling_protocols.md @@ -1,3 +1,25 @@ + Several tunneling protocols can be used to implement an overlay network. We choose Geneve as the main tunneling protocol at the moment and more tunneling diff --git a/docs/design/mp_datamodel.md b/docs/design/mp_datamodel.md index de7627b4..3e12812c 100644 --- a/docs/design/mp_datamodel.md +++ b/docs/design/mp_datamodel.md @@ -1,3 +1,26 @@ + + We categorize network objects and operators as generic, and data-plane specific. Generic network object primarily extends [Kubernetes Network Model](https://kubernetes.io/docs/concepts/cluster-administration/networking/#the-kubernetes-network-model). diff --git a/docs/design/mp_dpsupport.md b/docs/design/mp_dpsupport.md index 6f786a3d..9a1e99bd 100644 --- a/docs/design/mp_dpsupport.md +++ b/docs/design/mp_dpsupport.md @@ -1,3 +1,26 @@ + + This architecture is extensible to derive other data-plane systems and is compatible with existing cloud networking solutions (particularly neutron). For example, if we would like to introduce a L2 ovs that is responsible for managing diff --git a/docs/design/mp_ipam.md b/docs/design/mp_ipam.md index 61631ffa..faecfe26 100644 --- a/docs/design/mp_ipam.md +++ b/docs/design/mp_ipam.md @@ -1,3 +1,26 @@ + + The management-plane assigns IP addresses to endpoints using a simple IP address management (IPAM) service. The service is multi-tenant aware. In the first version, the IPAM service is local to the operator and provides very elementary diff --git a/docs/design/mp_overview.md b/docs/design/mp_overview.md index f4f28dea..a942fbd1 100644 --- a/docs/design/mp_overview.md +++ b/docs/design/mp_overview.md @@ -1,3 +1,26 @@ + + Mizar's management plane is based on Kubernetes based operators. The management-plane a fully distributed, elasticaly scaling, and kubernetes-native design. Several existing components allows this design to happen, which we diff --git a/docs/design/mp_workflows.md b/docs/design/mp_workflows.md index b403c68f..153c983d 100644 --- a/docs/design/mp_workflows.md +++ b/docs/design/mp_workflows.md @@ -1,3 +1,26 @@ + + When creating any object, there are **two states** that must persist to the API Server. These states are **Object Init** and **Object Provisioned**. Any other state may be communicated between operators by the Inter-Operators Communication diff --git a/docs/design/puml/create_bouncer_workflow.puml b/docs/design/puml/create_bouncer_workflow.puml index 8aa6906a..95f9e1a0 100644 --- a/docs/design/puml/create_bouncer_workflow.puml +++ b/docs/design/puml/create_bouncer_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/create_divider_workflow.puml b/docs/design/puml/create_divider_workflow.puml index e4fd2784..4c337429 100644 --- a/docs/design/puml/create_divider_workflow.puml +++ b/docs/design/puml/create_divider_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/create_droplet_workflow.puml b/docs/design/puml/create_droplet_workflow.puml index 8d14cd19..89eea78e 100644 --- a/docs/design/puml/create_droplet_workflow.puml +++ b/docs/design/puml/create_droplet_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/create_endpoint_workflow.puml b/docs/design/puml/create_endpoint_workflow.puml index b7bdeb85..81b6363a 100644 --- a/docs/design/puml/create_endpoint_workflow.puml +++ b/docs/design/puml/create_endpoint_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/create_network_workflow.puml b/docs/design/puml/create_network_workflow.puml index 765ccb14..b4c99fea 100644 --- a/docs/design/puml/create_network_workflow.puml +++ b/docs/design/puml/create_network_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/create_scaled_endpoint_workflow.puml b/docs/design/puml/create_scaled_endpoint_workflow.puml index 71f3e21a..fb6ee4bb 100644 --- a/docs/design/puml/create_scaled_endpoint_workflow.puml +++ b/docs/design/puml/create_scaled_endpoint_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/create_vpc_workflow.puml b/docs/design/puml/create_vpc_workflow.puml index 8a3b49e7..11c52d78 100644 --- a/docs/design/puml/create_vpc_workflow.puml +++ b/docs/design/puml/create_vpc_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber database API_Server diff --git a/docs/design/puml/delete_bouncer_workflow.puml b/docs/design/puml/delete_bouncer_workflow.puml index 8a32c209..c8e20a88 100644 --- a/docs/design/puml/delete_bouncer_workflow.puml +++ b/docs/design/puml/delete_bouncer_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/delete_divider_workflow.puml b/docs/design/puml/delete_divider_workflow.puml index 014cd2c1..0670f9f0 100644 --- a/docs/design/puml/delete_divider_workflow.puml +++ b/docs/design/puml/delete_divider_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/delete_endpoint_workflow.puml b/docs/design/puml/delete_endpoint_workflow.puml index 07468756..53115e48 100644 --- a/docs/design/puml/delete_endpoint_workflow.puml +++ b/docs/design/puml/delete_endpoint_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/delete_network_workflow.puml b/docs/design/puml/delete_network_workflow.puml index 6afd51f3..10e27e69 100644 --- a/docs/design/puml/delete_network_workflow.puml +++ b/docs/design/puml/delete_network_workflow.puml @@ -1,5 +1,25 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. skinparam monochrome true autonumber diff --git a/docs/design/puml/delete_scaled_endpoint_workflow.puml b/docs/design/puml/delete_scaled_endpoint_workflow.puml index b5495165..1939f59b 100644 --- a/docs/design/puml/delete_scaled_endpoint_workflow.puml +++ b/docs/design/puml/delete_scaled_endpoint_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/design/puml/delete_vpc_workflow.puml b/docs/design/puml/delete_vpc_workflow.puml index 354045d6..a6a6c0c9 100644 --- a/docs/design/puml/delete_vpc_workflow.puml +++ b/docs/design/puml/delete_vpc_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true skinparam group 10 diff --git a/docs/design/puml/direct_path.puml b/docs/design/puml/direct_path.puml index 7f0a157d..f358524f 100644 --- a/docs/design/puml/direct_path.puml +++ b/docs/design/puml/direct_path.puml @@ -1,4 +1,26 @@ @startuml + +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + autonumber participant "EP_A at Host A" as a participant "EP_B at Host B" as b diff --git a/docs/design/puml/direct_path_endpoint_deleted.puml b/docs/design/puml/direct_path_endpoint_deleted.puml index a563cc74..7f23888e 100644 --- a/docs/design/puml/direct_path_endpoint_deleted.puml +++ b/docs/design/puml/direct_path_endpoint_deleted.puml @@ -1,4 +1,26 @@ @startuml + +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + autonumber participant "EP_A at Host A" as a participant "Old host of b" as old diff --git a/docs/design/puml/direct_path_host_failure.puml b/docs/design/puml/direct_path_host_failure.puml index b0170f19..8a7a918c 100644 --- a/docs/design/puml/direct_path_host_failure.puml +++ b/docs/design/puml/direct_path_host_failure.puml @@ -1,4 +1,25 @@ @startuml + +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. autonumber participant "EP_A at Host A" as a participant "Failed host B" as b diff --git a/docs/design/puml/direct_path_inter_network.puml b/docs/design/puml/direct_path_inter_network.puml index 8b0de60e..051221a5 100644 --- a/docs/design/puml/direct_path_inter_network.puml +++ b/docs/design/puml/direct_path_inter_network.puml @@ -1,4 +1,26 @@ @startuml + +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + autonumber participant "EP_A at Host A" as a participant "EP_B at Host B" as b diff --git a/docs/design/puml/update_scaled_endpoint_workflow.puml b/docs/design/puml/update_scaled_endpoint_workflow.puml index 3bc4b2a8..18c167be 100644 --- a/docs/design/puml/update_scaled_endpoint_workflow.puml +++ b/docs/design/puml/update_scaled_endpoint_workflow.puml @@ -1,5 +1,26 @@ @startuml +' SPDX-License-Identifier: MIT +' Copyright (c) 2020 The Authors. + +' Authors: Sherif Abdelwahab <@zasherif> +' Phu Tran <@phudtran> + +' Permission is hereby granted, free of charge, to any person obtaining a copy +' of this software and associated documentation files (the "Software"), to deal +' in the Software without restriction, including without limitation the rights +' to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +' copies of the Software, and to permit persons to whom the Software is +' furnished to do so, subject to the following conditions:The above copyright +' notice and this permission notice shall be included in all copies or +' substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", +' WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +' TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +' NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +' FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +' TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +' THE USE OR OTHER DEALINGS IN THE SOFTWARE. + skinparam monochrome true autonumber diff --git a/docs/dev/contributing.md b/docs/dev/contributing.md index 10959652..4ab59044 100644 --- a/docs/dev/contributing.md +++ b/docs/dev/contributing.md @@ -1,3 +1,26 @@ + + ### Contributor Workflow Please do not ever hesitate to ask a question or send a pull request. diff --git a/docs/index.md b/docs/index.md index 81368422..4bb21171 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,26 @@ + + Welcome to Mizar - the open-source high-performance cloud-network powered by [ eXpress Data Path (XDP)](https://prototype-kernel.readthedocs.io/en/latest/networking/XDP/) and [Geneve protocol](https://tools.ietf.org/html/draft-ietf-nvo3-geneve-08) for high scale cloud. Mizar is a simple and efficient solution that lets you create a multi-tenant overlay network of a massive number of endpoints with extensible network functions that: diff --git a/docs/releases/release-notes.md b/docs/releases/release-notes.md index 54eb9bef..42b08623 100644 --- a/docs/releases/release-notes.md +++ b/docs/releases/release-notes.md @@ -1,3 +1,26 @@ + + ## Release 0.1 (09/30/2019) * A basic implementation of the data plane and a mini controller; diff --git a/docs/releases/roadmap.md b/docs/releases/roadmap.md index a6044ac5..1f9fecec 100644 --- a/docs/releases/roadmap.md +++ b/docs/releases/roadmap.md @@ -1,3 +1,26 @@ + + ## Release 0.1 (09/30/2019) This release includes: diff --git a/docs/releases/use_cases.md b/docs/releases/use_cases.md index 224da017..a2095419 100644 --- a/docs/releases/use_cases.md +++ b/docs/releases/use_cases.md @@ -1,3 +1,26 @@ + + Mizar shall support the following usage scenarios ## 1. VPC service of public cloud diff --git a/docs/user/faq.md b/docs/user/faq.md index 40d9c059..87b57ee8 100644 --- a/docs/user/faq.md +++ b/docs/user/faq.md @@ -1,3 +1,26 @@ + + ### What is the primary use cases of Mizar? Mizar provides a unified solution for computing runtimes (e.g., VM/Containers) networking in Cloud Computing. It is a step towards empowering super-scale cloud computing. diff --git a/docs/user/getting_started.md b/docs/user/getting_started.md index 0599def3..9b1e3643 100644 --- a/docs/user/getting_started.md +++ b/docs/user/getting_started.md @@ -1,3 +1,26 @@ + + # Basic Usage To start running Mizar, first you will need a Kubernetes cluster. Running Mizar will install experimental features on your cluster. **It is recommended that you use a test cluster to run Mizar.**