-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex___.html
More file actions
311 lines (251 loc) · 13.9 KB
/
Copy pathindex___.html
File metadata and controls
311 lines (251 loc) · 13.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<!-- Begin Jekyll SEO tag v2.8.0 -->
<title>C4 Protocol - Cloud Computing Common Connector | A standardized protocol for cloud service providers to integrate with enterprise-grade multi-cloud management platforms</title>
<meta name="generator" content="Jekyll v3.10.0">
<meta property="og:title" content="C4 Protocol - Cloud Computing Common Connector">
<meta property="og:locale" content="en_US">
<meta name="description" content="A standardized protocol for cloud service providers to integrate with enterprise-grade multi-cloud management platforms">
<meta property="og:description" content="A standardized protocol for cloud service providers to integrate with enterprise-grade multi-cloud management platforms">
<link rel="canonical" href="https://github.com/c4api/">
<meta property="og:url" content="https://github.com/c4api/">
<meta property="og:site_name" content="C4 Protocol - Cloud Computing Common Connector">
<meta property="og:type" content="website">
<meta name="twitter:card" content="summary">
<meta property="twitter:title" content="C4 Protocol - Cloud Computing Common Connector">
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebSite","description":"A standardized protocol for cloud service providers to integrate with enterprise-grade multi-cloud management platforms","headline":"C4 Protocol - Cloud Computing Common Connector","name":"C4 Protocol - Cloud Computing Common Connector","url":"https://github.com/c4api/"}</script>
<!-- End Jekyll SEO tag -->
<link rel="preconnect" href="https://fonts.gstatic.com">
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#157878">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="stylesheet" href="/c4api/assets/css/style.css?v=99d23fe0f315548c7437d3d225c14b73b0ac218d">
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
<!-- Setup Google Analytics -->
<!-- You can set your favicon here -->
<!-- link rel="shortcut icon" type="image/x-icon" href="/c4api/favicon.ico" -->
<!-- end custom head snippets -->
</head>
<body>
<a id="skip-to-content" href="#content">Skip to the content.</a>
<header class="page-header" role="banner">
<h1 class="project-name">C4 Protocol - Cloud Computing Common Connector</h1>
<h2 class="project-tagline">A standardized protocol for cloud service providers to integrate with enterprise-grade multi-cloud management platforms</h2>
<a href="https://github.com/Elemento-Modular-Cloud/c4api" class="btn">View on GitHub</a>
</header>
<main id="content" class="main-content" role="main">
<h1 id="c4-protocol---cloud-computing-common-connector">C4 Protocol - Cloud Computing Common Connector</h1>
<p>A standardized protocol for cloud service providers to integrate with enterprise-grade multi-cloud management platforms. Simplify your integration, expand your market reach.</p>
<h2 id="overview">Overview</h2>
<p>The C4 Protocol (Cloud Computing Common Connector) provides a universal API specification that enables cloud service providers to integrate with multi-cloud management platforms. This repository hosts the official API specifications and documentation website.</p>
<p>Are you a CSP? Come onboard!
Joining us is quite simple, here’s everything you need to know to join the Biggest Cloud resource marketplace.</p>
<p>Let’s start with some general details.</p>
<h1 id="c4-does-it-explode">C4, does it explode?</h1>
<p>The Elemento C4 protocol is a standardized protocol that allows CSP to communicate with Dynamo’s environment which is used through Mesons to onboard new cloud providers from anywhere!</p>
<h2 id="architecture">Architecture</h2>
<h3 id="c4-protocol-positioning">C4 Protocol Positioning</h3>
@startmermaid
Enterprise[Enterprise Customers] --> MCM[Multi-Cloud Management Platforms]
MCM --> C4[C4 Protocol]
C4 --> CSP1[Cloud Service Provider 1]
C4 --> CSP2[Cloud Service Provider 2]
C4 --> CSP3[Cloud Service Provider 3]
classDef enterprise fill:#f9f,stroke:#333,stroke-width:2px;
classDef platform fill:#bbf,stroke:#333,stroke-width:2px;
classDef protocol fill:#bfb,stroke:#333,stroke-width:2px;
classDef provider fill:#fbb,stroke:#333,stroke-width:2px;
class Enterprise enterprise;
class MCM platform;
class C4 protocol;
class CSP1,CSP2,CSP3 provider;
@endmermaid
<h3 id="communication-flow">Communication Flow</h3>
<pre class="mermaid">sequenceDiagram
participant Client as Enterprise Client
participant MCM as Multi-Cloud Manager
participant C4 as C4 Protocol API
participant CSP as Cloud Service Provider
Client->>MCM: Request resource creation
MCM->>C4: Translate to C4 API call
C4->>CSP: Forward standardized request
CSP->>C4: Return provider-specific response
C4->>MCM: Normalize response
MCM->>Client: Present unified result
</pre>
<h3 id="service-architecture">Service Architecture</h3>
<pre class="mermaid">flowchart LR
subgraph "C4 Protocol Services"
Meson[Meson - Compute\nPort 7777]
Storage[Storage\nPort 7772]
PaaS[PaaS Services]
SaaS[SaaS Services]
end
subgraph "Cloud Provider"
VMs[Virtual Machines]
Volumes[Storage Volumes]
K8s[Kubernetes]
S3[Object Storage]
DB[Databases]
LB[Load Balancers]
end
Meson --> VMs
Storage --> Volumes
PaaS --> K8s
PaaS --> S3
PaaS --> DB
PaaS --> LB
SaaS --> Apps[Managed Applications]
</pre>
<h2 id="strategic-value-proposition">Strategic Value Proposition</h2>
<ul>
<li>
<strong>Market Access</strong>: Tap into a growing ecosystem of enterprise customers seeking multi-cloud solutions</li>
<li>
<strong>Standardized Integration</strong>: Simple API compliance process with clear documentation and support</li>
<li>
<strong>Competitive Edge</strong>: Join leading providers in offering seamless multi-cloud capabilities</li>
<li>
<strong>Enterprise Ready</strong>: Meet enterprise requirements for cloud service integration and management</li>
</ul>
<h2 id="api-reference">API Reference</h2>
<h3 id="meson-compute-endpoints">Meson (Compute) Endpoints</h3>
<p>Endpoints for virtual machine management on the cloud provider. The matcher server listens on port 7777.</p>
<h4 id="status--information">Status & Information</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/status</code> - Returns details in plain text format about the Meson provider</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/statusjson</code> - Returns details in JSON format about the Meson provider</li>
</ul>
<h4 id="vm-management">VM Management</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/running</code> - List running instances with detailed status information</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/canallocate</code> - Check if a configuration can be allocated on the cloud provider</li>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/register</code> - Create new instances with specified configurations</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/unregister</code> - Remove instances and cleanup resources</li>
</ul>
<h3 id="storage-endpoints">Storage Endpoints</h3>
<p>Endpoints for disk/volume management on the cloud provider. The storage server listens on port 7772.</p>
<h4 id="volume-management">Volume Management</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/create</code> - Create a disk on the cloud provider</li>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/info</code> - Returns information about a disk by volume ID</li>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/accessible</code> - Returns all visible disks for a client</li>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/destroy</code> - Delete a disk on the cloud provider</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/cancreate</code> - Check if a volume configuration can be created</li>
</ul>
<h3 id="paas-services">PaaS Services</h3>
<p>Platform as a Service endpoints for various cloud services. Each service follows a consistent pattern of endpoints.</p>
<h4 id="s3-object-storage">S3 Object Storage</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/s3/create</code> - Create a new S3 bucket</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/s3/info</code> - Get information about an S3 bucket</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/s3/running</code> - List all S3 buckets</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/s3/delete</code> - Delete an S3 bucket</li>
</ul>
<h4 id="kubernetes-kaas">Kubernetes (KAAS)</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/kaas/create</code> - Create a new Kubernetes cluster</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/kaas/info</code> - Get information about a Kubernetes cluster</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/kaas/running</code> - List all Kubernetes clusters</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/kaas/delete</code> - Delete a Kubernetes cluster</li>
</ul>
<h4 id="load-balancer">Load Balancer</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/loadbalancer/create</code> - Create a new load balancer</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/loadbalancer/info</code> - Get information about a load balancer</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/loadbalancer/running</code> - List all load balancers</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/loadbalancer/delete</code> - Delete a load balancer</li>
</ul>
<h4 id="elastic-ip">Elastic IP</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/elasticip/create</code> - Create a new elastic IP</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/elasticip/info</code> - Get information about an elastic IP</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/elasticip/running</code> - List all elastic IPs</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/elasticip/delete</code> - Delete an elastic IP</li>
</ul>
<h4 id="database-as-a-service-dbaas">Database as a Service (DBaaS)</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/dbaas/create</code> - Create a new database instance</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/dbaas/info</code> - Get information about a database instance</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/dbaas/running</code> - List all database instances</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/dbaas/delete</code> - Delete a database instance</li>
</ul>
<h3 id="saas-services">SaaS Services</h3>
<p>Software as a Service endpoints for managed applications.</p>
<h4 id="jupyter-notebook">Jupyter Notebook</h4>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">POST /api/v1.0/jupyter/create</code> - Create a new Jupyter notebook instance</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/jupyter/info</code> - Get information about a Jupyter notebook instance</li>
<li>
<code class="language-plaintext highlighter-rouge">GET /api/v1.0/jupyter/running</code> - List all Jupyter notebook instances</li>
<li>
<code class="language-plaintext highlighter-rouge">DELETE /api/v1.0/jupyter/delete</code> - Delete a Jupyter notebook instance</li>
</ul>
<h2 id="common-api-features">Common API Features</h2>
<h3 id="asynchronous-operations">Asynchronous Operations</h3>
<p>Many endpoints support both synchronous and asynchronous operations via the <code class="language-plaintext highlighter-rouge">async</code> header:</p>
<ul>
<li>When set to <code class="language-plaintext highlighter-rouge">true</code>, the response includes a <code class="language-plaintext highlighter-rouge">poolingURL</code> to check operation status</li>
<li>When set to <code class="language-plaintext highlighter-rouge">false</code>, the operation completes before responding</li>
</ul>
<h3 id="consistent-response-format">Consistent Response Format</h3>
<p>All API responses follow a consistent JSON structure with:</p>
<ul>
<li>Resource identifiers (UUIDs)</li>
<li>Resource metadata</li>
<li>Operation status</li>
<li>Error information when applicable</li>
</ul>
<footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/Elemento-Modular-Cloud/c4api">c4api</a> is maintained by <a href="https://github.com/Elemento-Modular-Cloud">Elemento-Modular-Cloud</a>.</span>
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
</footer>
</main>
</body>
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.9.1/dist/mermaid.js"></script>
<!-- Initialize Mermaid -->
<script>
document.addEventListener("DOMContentLoaded", function() {
console.log("Starting mermaid")
mermaid.initialize({startOnLoad:true});
});
</script>
</html>