Merge pull request #1084 from dseevr-dev/subtree_contivmodel

Subtree contivmodel into netplugin

Author: dseevr

Makefile

@@ -8,7 +8,8 @@
 DEFAULT_DOCKER_VERSION := 1.12.6
 V2PLUGIN_DOCKER_VERSION := 1.13.1
 SHELL := /bin/bash
-EXCLUDE_DIRS := bin docs Godeps scripts vagrant vendor install
+# TODO: contivmodel should be removed once its code passes golint and misspell
+EXCLUDE_DIRS := bin docs Godeps scripts vagrant vendor install contivmodel
 PKG_DIRS := $(filter-out $(EXCLUDE_DIRS),$(subst /,,$(sort $(dir $(wildcard */)))))
 TO_BUILD := ./netplugin/ ./netmaster/ ./netctl/netctl/ ./mgmtfn/k8splugin/contivk8s/ ./mgmtfn/mesosplugin/netcontiv/
 HOST_GOBIN := `if [ -n "$$(go env GOBIN)" ]; then go env GOBIN; else dirname $$(which go); fi`

contivmodel/.gitignore

@@ -0,0 +1,3 @@
+# data is extracted from this file and merged into spec/docs/contiv.html as part of the build process
+# but we don't actually need to keep it around.
+spec/docs/auth_proxy.html

contivmodel/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 Cisco Systems Inc. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

contivmodel/Makefile

@@ -0,0 +1,17 @@
+
+.PHONY: all build godep modelgen systemtests
+
+all: build
+
+build: modelgen
+	@bash ./scripts/build.sh
+
+godep:
+	godep save ./...
+
+modelgen:
+	@if [ -z "`which modelgen`" ]; then go get -v github.com/contiv/modelgen; fi
+
+# systemtest runs all of the systemtests
+systemtests:
+	go test -v -timeout 5m ./systemtests -check.v

contivmodel/README.md

@@ -0,0 +1,38 @@
+[![GoDoc](https://godoc.org/github.com/contiv/contivmodel/client?status.png)](https://godoc.org/github.com/contiv/contivmodel/client)
+
+# Contiv Object Model
+This is how current object model looks like:
+
+![Contiv Object Model](./contivModel.png "Contiv Object Model")
+
+### Using go client
+Here is an example of how to use contiv go client
+
+```
+package main
+
+import (
+    "log"
+
+    "github.com/contiv/contivModel/client"
+)
+
+func main() {
+    cl, err := client.NewContivClient("localhost:9999")
+    if err != nil {
+        log.Fatal(err)
+    }
+    
+    // Define a policy
+    policy := client.Policy{
+        TenantName: "tenant1",
+        PolicyName: "policy",
+    }
+    
+    // Create policy
+    err = cl.PostPolicy(policy)
+    if err != nil {
+        log.Errorf("Policy Creation failed. Err: %v", err)
+    }
+}
+```

contivmodel/aciGw.json

@@ -0,0 +1,59 @@
+{
+	"name": "contivModel",
+	"objects": [
+		{
+			"name": "aciGw",
+			"version": "v1",
+			"type": "object",
+			"key": [ "name"],
+			"cfgProperties": {
+				"name": {
+					"type": "string",
+					"title": "name of this block(must be 'aciGw')",
+					"length": 64,
+					"format": "^(aciGw)$",
+					"ShowSummary": true
+				},
+				"pathBindings": {
+					"type": "string",
+					"title": "List of ACI fabric ports connected to cluster",
+					"length": 2048,
+					"format": "^$|^(topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\\\[eth[0-9]{1,2}/[0-9]{1,2}\\\\]){1}(,topology/pod-[0-9]{1,4}/paths-[0-9]{1,4}/pathep-\\\\[eth[0-9]{1,2}/[0-9]{1,2}\\\\])*$",
+					"ShowSummary": true
+				},
+				"nodeBindings": {
+					"type": "string",
+					"title": "List of ACI complete nodes to be bound",
+					"length": 2048,
+					"format": "^$|^(topology/pod-[0-9]{1,4}/node-[0-9]{1,4}){1}(,topology/pod-[0-9]{1,4}/node-[0-9]{1,4})*$",
+					"ShowSummary": true
+				},
+				"physicalDomain": {
+					"type": "string",
+					"title": "Name of the physical domain",
+					"length": 128,
+					"format": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\\\-]*[a-zA-Z0-9])\\\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\\\-]*[A-Za-z0-9])$"
+				},
+                                "enforcePolicies": {
+                                        "type": "string",
+                                        "title": "Enforce security policy",
+                                        "length": 64,
+                                        "format": "^(yes|no){1}$",
+                                        "ShowSummary": true
+                                },
+                                "includeCommonTenant": {
+                                        "type": "string",
+                                        "title": "Include common tenant when searching for objects",
+                                        "length": 64,
+                                        "format": "^(yes|no){1}$",
+                                        "ShowSummary": true
+                                }
+			},
+			"operProperties": {
+				"numAppProfiles": {
+					"type": "int"
+				}
+			}
+		}
+	]
+}

contivmodel/appProfile.json

@@ -0,0 +1,40 @@
+{
+	"name": "contivModel",
+	"objects": [
+		{
+			"name": "appProfile",
+			"type": "object",
+			"version": "v1",
+			"key": [ "tenantName", "appProfileName" ],
+			"cfgProperties": {
+				"tenantName": {
+					"type": "string",
+					"title": "Tenant Name",
+					"length": 64,
+					"format": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\\\-]*[a-zA-Z0-9])\\\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\\\-]*[A-Za-z0-9])$"
+				},
+				"appProfileName": {
+					"type": "string",
+					"title": "Application Profile Name",
+					"length": 64,
+					"format": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\\\-]*[a-zA-Z0-9])\\\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\\\-]*[A-Za-z0-9])$"
+				},
+				"endpointGroups": {
+					"type": "array",
+					"items": "string",
+					"title": "Member groups of the appProf"
+				}
+			},
+			"link-sets": {
+				"endpointGroups": {
+					"ref": "endpointGroup"
+				}
+			},
+			"links": {
+				"tenant": {
+					"ref": "tenant"
+				}
+			}
+		}
+	]
+}

contivmodel/bgphost.json

@@ -0,0 +1,57 @@
+{
+    "name": "contivModel",
+    "objects": [{
+        "name": "Bgp",
+        "version": "v1",
+        "type": "object",
+        "key": ["hostname"],
+        "cfgProperties": {
+            "hostname": {
+                "type": "string",
+                "title": "host name",
+                "length": 256,
+    			"format": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\\\-]*[a-zA-Z0-9])\\\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\\\-]*[A-Za-z0-9])$"
+            },
+            "routerip": {
+                "type": "string",
+                "title": "Bgp router intf ip",
+                "format": "^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})(\\\\-(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]))?/(3[0-1]|2[0-9]|1[0-9]|[1-9])$"
+            },
+            "as": {
+                "type": "string",
+                "title": "AS id",
+                "length": 64
+            },
+            "neighbor-as": {
+                "type": "string",
+                "title": "AS id",
+                "length": 64
+            },
+            "neighbor": {
+                "type": "string",
+                "title": "Bgp  neighbor",
+                "length": 15,
+                "format": "^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\\\\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})?$"
+            }
+         },
+         "operProperties": {
+            "numRoutes": {
+                "type": "int",
+                "title": "number of routes"
+            },
+            "neighborStatus": {
+                "type": "string",
+                "title": "neighbor status"
+            },
+            "adminStatus": {
+                "type": "string",
+                "title": "admin status"
+            },
+            "routes": {
+                "type": "array",
+                "items": "string",
+                "title": "routes"
+            }
+         }
+    }]
+}