Skip to content

Commit ef9d0bf

Browse files
rhimrhim
authored
Contiv spec auto-generation (#53)
* Contiv spec auto-generation 1. Auto generation of netmaster.raml from contivModel specification. This file is generated using contivModel2raml.rb, and needs to be put in contiv/libraries. 2. Authored contiv.raml specification 3. Authored auth_proxy.raml specification 4. To generate contiv.html, run make docs
1 parent 9b22937 commit ef9d0bf

12 files changed

+1359
-0
lines changed

‎spec/Dockerfile

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
FROM node:alpine
2+
3+
RUN npm install -g raml2html
4+
5+
COPY . /contiv
6+
7+
WORKDIR /contiv
8+
9+
RUN raml2html -i contiv.raml -o contiv.html
10+
11+
ENTRYPOINT ["/bin/sh"]

‎spec/Makefile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
all: docs
2+
3+
docs:
4+
@./build.sh
5+
6+
.PHONY: docs

‎spec/build.sh

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/bash
2+
3+
set -euo pipefail
4+
5+
docker build -t contiv/spec .
6+
cid=$(docker run -itd contiv/spec)
7+
docker cp ${cid}:/contiv/contiv.html .
8+
docker rm -f -v ${cid}

‎spec/contiv.raml

+280
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
#%RAML 1.0
2+
title: Contiv
3+
description: Contiv API Specification
4+
version: v1
5+
baseUri:
6+
value: http://{serverfqdn}:10000/api/{version}
7+
(rediractable): true
8+
baseUriParameters:
9+
serverfqdn:
10+
type: string
11+
protocols: [ HTTPS ]
12+
mediaType: [ application/json ]
13+
14+
resourceTypes:
15+
collection: !include contiv/schemas/collection.raml
16+
non-upd-collection-item: !include contiv/schemas/non-upd-collection-item.raml
17+
collection-item: !include contiv/schemas/collection-item.raml
18+
ro-collection-item: !include contiv/schemas/ro-collection-item.raml
19+
20+
annotationTypes:
21+
info:
22+
properties:
23+
license:
24+
type: string
25+
enum: [ "Apache 2.0" ]
26+
allowedTargets: API
27+
rediractable: boolean
28+
29+
securitySchemes:
30+
custom_scheme: !include contiv/schemas/custom-scheme.raml
31+
32+
# Resource templates
33+
uses:
34+
auth_proxy: contiv/libraries/auth_proxy.raml
35+
netmaster: contiv/libraries/netmaster.raml
36+
37+
securedBy: custom_scheme
38+
39+
# auth_proxy endpoints
40+
/auth_proxy:
41+
displayName: Auth API
42+
description: Authentication/Authorization related API
43+
44+
/version:
45+
get:
46+
securedBy: [ null ]
47+
responses:
48+
200:
49+
body:
50+
application/json: |
51+
{ "version": "1.0.0-beta" }
52+
53+
/health:
54+
get:
55+
securedBy: [ null ]
56+
responses:
57+
200:
58+
body:
59+
application/json:
60+
type: auth_proxy.health
61+
62+
63+
/login:
64+
post:
65+
description: Login to Contiv API server
66+
securedBy: [ null ]
67+
body:
68+
application/json:
69+
type: auth_proxy.login
70+
responses:
71+
200:
72+
body:
73+
application/json:
74+
type: auth_proxy.login_response
75+
400:
76+
401:
77+
78+
/local_users:
79+
type: {collection: {provider: auth_proxy}}
80+
displayName: Local Users
81+
82+
/{username}:
83+
type: {collection-item: {provider: auth_proxy}}
84+
displayName: Local User
85+
86+
/ldap_configuration:
87+
type: {collection-item: {provider: auth_proxy}}
88+
displayName: LDAP Configuration
89+
put:
90+
91+
/authorizations:
92+
type: {collection: {provider: auth_proxy}}
93+
displayName: Authorizations
94+
95+
/{authzUUID}:
96+
type: {non-upd-collection-item: {provider: auth_proxy}}
97+
displayName: Authorization
98+
99+
#Netmaster endpoints. Most of this can be auto-gen
100+
/inspect:
101+
displayName: Inspect
102+
description: Inspect APIs for various Contiv managed objects
103+
104+
/aciGws:
105+
/aciGw:
106+
type: {ro-collection-item: {provider: netmaster}}
107+
/appProfiles:
108+
/{appProfileName}:
109+
type: {ro-collection-item: {provider: netmaster}}
110+
/{tenantName}:
111+
type: {ro-collection-item: {provider: netmaster}}
112+
/Bgps:
113+
/{hostname}:
114+
type: {ro-collection-item: {provider: netmaster}}
115+
/endpoints:
116+
/{endpointID}:
117+
type: {ro-collection-item: {provider: netmaster}}
118+
/endpointGroups:
119+
/{tenantName}:
120+
type: {ro-collection-item: {provider: netmaster}}
121+
/{groupName}:
122+
type: {ro-collection-item: {provider: netmaster}}
123+
/extContractsGroups:
124+
/{tenantName}:
125+
type: {ro-collection-item: {provider: netmaster}}
126+
/{contractsGroupName}:
127+
type: {ro-collection-item: {provider: netmaster}}
128+
/globals:
129+
/global:
130+
type: {ro-collection-item: {provider: netmaster}}
131+
/netprofiles:
132+
/{tenantName}:
133+
type: {ro-collection-item: {provider: netmaster}}
134+
/{profileName}:
135+
type: {ro-collection-item: {provider: netmaster}}
136+
/networks:
137+
/{tenantName}:
138+
type: {ro-collection-item: {provider: netmaster}}
139+
/{networkName}:
140+
type: {ro-collection-item: {provider: netmaster}}
141+
/policys:
142+
/{tenantName}:
143+
type: {ro-collection-item: {provider: netmaster}}
144+
/{policyName}:
145+
type: {ro-collection-item: {provider: netmaster}}
146+
/rules:
147+
/{tenantName}:
148+
type: {ro-collection-item: {provider: netmaster}}
149+
/{policyName}:
150+
type: {ro-collection-item: {provider: netmaster}}
151+
/{ruleId}:
152+
type: {ro-collection-item: {provider: netmaster}}
153+
/serviceLBs:
154+
/{tenantName}:
155+
type: {ro-collection-item: {provider: netmaster}}
156+
/{serviceName}:
157+
type: {ro-collection-item: {provider: netmaster}}
158+
/tenants:
159+
/{tenantName}:
160+
type: {ro-collection-item: {provider: netmaster}}
161+
162+
/aciGws:
163+
type: {collection: {provider: netmaster}}
164+
displayName: ACI Gateways
165+
description: ACI gateway settings
166+
167+
/aciGw:
168+
type: {collection-item: {provider: netmaster}}
169+
put:
170+
171+
/appProfiles:
172+
type: {collection: {provider: netmaster}}
173+
displayName: Application Profiles
174+
175+
/{tenantName}:
176+
type: {collection-item: {provider: netmaster}}
177+
put:
178+
179+
/{appProfileName}:
180+
type: {collection-item: {provider: netmaster}}
181+
put:
182+
183+
/Bgps:
184+
type: {collection: {provider: netmaster}}
185+
displayName: BGP
186+
description: BGP settings
187+
188+
/{hostname}:
189+
type: {collection-item: {provider: netmaster}}
190+
put:
191+
192+
/endpointGroups:
193+
type: {collection: {provider: netmaster}}
194+
displayName: Endpoint Groups
195+
/{tenantName}:
196+
type: {collection-item: {provider: netmaster}}
197+
put:
198+
/{groupName}:
199+
type: {collection-item: {provider: netmaster}}
200+
put:
201+
202+
/extContractsGroups:
203+
type: {collection: {provider: netmaster}}
204+
displayName: External Contract Groups
205+
/{tenantName}:
206+
type: {collection-item: {provider: netmaster}}
207+
put:
208+
/{contractsGroupName}:
209+
type: {collection-item: {provider: netmaster}}
210+
put:
211+
212+
/globals:
213+
type: {collection: {provider: netmaster}}
214+
displayName: Globals
215+
description: Contiv global settings
216+
217+
/global:
218+
type: {collection-item: {provider: netmaster}}
219+
displayName: Global
220+
put:
221+
222+
/netprofiles:
223+
type: {collection: {provider: netmaster}}
224+
displayName: Network Profiles
225+
/{tenantName}:
226+
type: {collection-item: {provider: netmaster}}
227+
put:
228+
/{profileName}:
229+
type: {collection-item: {provider: netmaster}}
230+
put:
231+
232+
/networks:
233+
type: {collection: {provider: netmaster}}
234+
displayName: Networks
235+
/{tenantName}:
236+
type: {collection-item: {provider: netmaster}}
237+
put:
238+
/{networkName}:
239+
type: {collection-item: {provider: netmaster}}
240+
put:
241+
242+
/policys:
243+
type: {collection: {provider: netmaster}}
244+
displayName: Policies
245+
/{tenantName}:
246+
type: {collection-item: {provider: netmaster}}
247+
put:
248+
/{policyName}:
249+
type: {collection-item: {provider: netmaster}}
250+
put:
251+
252+
/rules:
253+
type: {collection: {provider: netmaster}}
254+
displayName: Rules
255+
/{tenantName}:
256+
type: {collection-item: {provider: netmaster}}
257+
put:
258+
/{policyName}:
259+
type: {collection-item: {provider: netmaster}}
260+
put:
261+
/{ruleId}:
262+
type: {collection-item: {provider: netmaster}}
263+
put:
264+
265+
/serviceLBs:
266+
type: {collection: {provider: netmaster}}
267+
displayName: Service Load Balancers
268+
/{tenantName}:
269+
type: {collection-item: {provider: netmaster}}
270+
put:
271+
/{serviceName}:
272+
type: {collection-item: {provider: netmaster}}
273+
put:
274+
275+
/tenants:
276+
type: {collection: {provider: netmaster}}
277+
displayName: Tenants
278+
/{tenantName}:
279+
type: {collection-item: {provider: netmaster}}
280+
put:

0 commit comments

Comments
 (0)