Skip to content

Commit 9687708

Browse files
petesfrenchpetesfrench
authored
Migrate maas.io/docs/api & maas.io/support (#1808)
* Migrate the redirects from maas.io * Migrate /support page * Migrate /api page & tests
1 parent ecb8a05 commit 9687708

7 files changed

Lines changed: 1987 additions & 4 deletions

File tree

‎redirects.yaml‎

Lines changed: 1243 additions & 1 deletion
Large diffs are not rendered by default.

‎templates/maas/docs/_api.html‎

Lines changed: 358 additions & 0 deletions
Large diffs are not rendered by default.

‎templates/maas/support.html‎

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
{% extends "base_index.html" %}
2+
3+
{% block title %}Bare metal support{% endblock %}
4+
5+
{% block meta_description %}
6+
Get help for all your bare metal needs with Canonical, from enterprise bare metal support to training and professional services.
7+
{% endblock %}
8+
9+
{% block meta_copydoc %}
10+
https://docs.google.com/document/d/1oEF37NP9bDuKQpKBQjUfWleN3yQ3QRUp9d2pLiKryCg/edit
11+
{% endblock meta_copydoc %}
12+
13+
{% block content %}
14+
15+
<section class="p-takeover--dark">
16+
<div class="row">
17+
<div class="col-6 u-vertically-center">
18+
<h1>Get bare metal-support</h1>
19+
<p>
20+
Need help? Canonical offers several options for enterprise support, as well as training and professional services.
21+
</p>
22+
<p>
23+
<a class="p-button--positive" href="/maas/contact-us">Get in touch</a>
24+
<a class="p-link--inverted is-dark"
25+
href="https://ubuntu.com/engage/bare-metal-kubernetes">Read the MAAS whitepaper&nbsp;&rsaquo;</a>
26+
</p>
27+
</div>
28+
<div class="col-6 u-hide--small u-hide--medium u-align--center">
29+
{{ image (
30+
url="https://assets.ubuntu.com/v1/b817fd65-169519811-c2a42414-f032-4131-811e-2d77fc4785b9.svg",
31+
alt="",
32+
width="325",
33+
height="273",
34+
hi_def=True,
35+
loading="lazy"
36+
) | safe
37+
}}
38+
</div>
39+
</div>
40+
</section>
41+
42+
<section class="p-strip">
43+
<div class="row">
44+
<div class="col-7">
45+
<h2>Bare metal enterprise support</h2>
46+
<p>
47+
MAAS is freely available, open source software from Canonical. However, if you need enterprise support from the people that know MAAS best, then you can get it in one of two ways:
48+
</p>
49+
<ol>
50+
<li>Ubuntu Pro for Infrastructure</li>
51+
<li>MAAS Standalone</li>
52+
</ol>
53+
</div>
54+
</div>
55+
</section>
56+
57+
<section class="p-strip--light">
58+
<div class="row">
59+
<div class="col-6">
60+
<h2>Ubuntu Pro for Infrastructure</h2>
61+
<p>
62+
Support and commercial capabilities for MAAS are included with <a href="https://www.ubuntu.com/pricing/pro">Ubuntu Pro for Infrastructure</a>. This support is charged on a per-machine basis. For example, if Ubuntu Pro is purchased for 100 machines, then MAAS support is also included for those 100 machines.
63+
</p>
64+
</div>
65+
</div>
66+
</section>
67+
68+
<section class="p-strip">
69+
<div class="row">
70+
<div class="col-8 u-sv3">
71+
<h2>MAAS Standalone support</h2>
72+
<p>
73+
In case you don't want support for Ubuntu or other Canonical products on machines that you want to manage with MAAS, then you can buy MAAS Standalone support instead. To be eligible for standalone support, Ubuntu Pro is always required for the machines hosting MAAS itself. The pricing for standalone support for machines managed by MAAS is as follows:
74+
</p>
75+
</div>
76+
</div>
77+
<div class="u-fixed-width">
78+
<table aria-label="MAAS standalone support pricing table">
79+
<thead>
80+
<tr>
81+
<th></th>
82+
<th class="u-align--center">Free</th>
83+
<th class="u-align--center">Essential</th>
84+
<th class="u-align--center">Standard</th>
85+
<th class="u-align--center">Advanced</th>
86+
</tr>
87+
</thead>
88+
<tbody>
89+
<tr>
90+
<th>Per managed machine &ndash; annual</th>
91+
<td class="u-align--center">&ndash;</td>
92+
<td class="u-align--center">$30</td>
93+
<td class="u-align--center">$50</td>
94+
<td class="u-align--center">$100</td>
95+
</tr>
96+
<tr>
97+
<th>Phone and ticket support</th>
98+
<td class="u-align--center">&ndash;</td>
99+
<td class="u-align--center">&ndash;</td>
100+
<td class="u-align--center">Office hours</td>
101+
<td class="u-align--center">24 hours a day everyday</td>
102+
</tr>
103+
<tr>
104+
<th>Response time &ndash; SLA Sev 1</th>
105+
<td class="u-align--center">&ndash;</td>
106+
<td class="u-align--center">&ndash;</td>
107+
<td class="u-align--center">4 hours</td>
108+
<td class="u-align--center">1 hour</td>
109+
</tr>
110+
<tr>
111+
<th>Knowledge Base</th>
112+
<td class="u-align--center">&ndash;</td>
113+
<td class="u-align--center">
114+
<i class="p-icon--success"></i>
115+
</td>
116+
<td class="u-align--center">
117+
<i class="p-icon--success"></i>
118+
</td>
119+
<td class="u-align--center">
120+
<i class="p-icon--success"></i>
121+
</td>
122+
</tr>
123+
<tr>
124+
<th>High availability (HA) support</th>
125+
<td class="u-align--center">&ndash;</td>
126+
<td class="u-align--center">
127+
<i class="p-icon--success"></i>
128+
</td>
129+
<td class="u-align--center">
130+
<i class="p-icon--success"></i>
131+
</td>
132+
<td class="u-align--center">
133+
<i class="p-icon--success"></i>
134+
</td>
135+
</tr>
136+
<tr>
137+
<th></th>
138+
<td class="u-align--center">
139+
<a href="/maas/docs/how-to-get-maas-up-and-running#p-9034-install-maas-snap-or-packages">Install MAAS</a>
140+
</td>
141+
<td class="u-align--center">
142+
<a href="/maas/contact-us">Contact us</a>
143+
</td>
144+
<td class="u-align--center">
145+
<a href="/maas/contact-us">Contact us</a>
146+
</td>
147+
<td class="u-align--center">
148+
<a href="/maas/contact-us">Contact us</a>
149+
</td>
150+
</tr>
151+
</tbody>
152+
</table>
153+
</div>
154+
</section>
155+
156+
<section class="p-strip--light">
157+
<div class="row">
158+
<div class="col-7">
159+
<h2>Professional services</h2>
160+
<p>
161+
When choosing to adopt MAAS, particularly for larger, production grade systems, there are many considerations that need to be taken into account. Canonical offers flexible professional services to kick start your project. Examples of things you can get help with include:
162+
</p>
163+
<ul class="p-list">
164+
<li class="p-list__item is-ticked">
165+
Basic Network Connectivity Validation notifying the customer of any systems which are unreachable through basic network testing.
166+
</li>
167+
<li class="p-list__item is-ticked">
168+
Review of customer-provided or chosen hardware make/model ("Customer Hardware"), making recommendations (if any) for any hardware specifications modifications that will improve cloud deployment success.
169+
</li>
170+
<li class="p-list__item is-ticked">
171+
Canonical will work with chosen Hardware vendors to deliver a specification that includes installation and testing of necessary kernel drivers.
172+
</li>
173+
<li class="p-list__item is-ticked">
174+
Review of hardware bios, firmware, and driver versions, and if necessary update to ensure compatibility.
175+
</li>
176+
<li class="p-list__item is-ticked">
177+
Installation of MAAS on customer-provided Hardware with customization of curtin install scripts to deploy drivers, include custom installation processes, etc. as required by Canonical. Supported on Ubuntu and Centos/RHEL images only.
178+
</li>
179+
<li class="p-list__item is-ticked">
180+
During the scope of work, if any customer Hardware fails to boot, commission, or is inaccessible, Canonical will work with the customer team to diagnose & troubleshoot any related hardware, software, or network issues.
181+
</li>
182+
<li class="p-list__item is-ticked">
183+
Work directly with the customer's network team to configure, test, and validate network configuration requirements.
184+
</li>
185+
</ul>
186+
</div>
187+
</div>
188+
</section>
189+
190+
<section class="p-strip">
191+
<div class="row">
192+
<div class="col-7">
193+
<h2>Training</h2>
194+
<p>Canonical offers a training course to get you up-to-speed with MAAS as quickly as possible.</p>
195+
<p>
196+
The course is intended to enable its attendees to assume full command of their on premises MAAS installation and its managed server estate. The target audience is system administrators, DevOps engineers, and infrastructure operators. The focal points of the curriculum are understanding MAAS' components, installing and configuring them, as well as ongoing MAAS operations for physical and virtual machines (KVM), network configuration and image management.
197+
</p>
198+
<p>
199+
Each section contains a theory session (presentation by an instructor) followed immediately by a practical lab. The practical lab introduces a series of core competencies for the section and students will sign off on successful completion of each lab. By combining the theoretical background with hands-on exercises, the course encourages better assimilation of the material and deeper understanding. Finally, students are provided with complete step-by-step documentation, ensuring that the material is readily available for future review.
200+
</p>
201+
</div>
202+
</div>
203+
</section>
204+
205+
<section class="p-strip--light">
206+
<div class="row">
207+
<div class="col-7">
208+
<h2>Contact us today!</h2>
209+
<p>
210+
If you are in need of the above or would like to learn more, don't hesitate to <a href="/maas/contact-us">contact us at any time</a>.
211+
</p>
212+
</div>
213+
</div>
214+
</section>
215+
216+
{% endblock %}

‎tests/openapi_example.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
info:
2+
version: 2.0.0
3+
openapi: 3.0.0
4+
paths:
5+
/account/op-create_authorisation_token:
6+
post:
7+
description: Create an authorisation OAuth token and OAuth consumer.
8+
operationId: AccountHandler_create_authorisation_token
9+
responses:
10+
'200':
11+
content:
12+
application/json:
13+
schema:
14+
additionalProperties: true
15+
type: object
16+
description: 'A JSON object containing: ``token_key``, ``token_secret``,
17+
``consumer_key``, and ``name``.'
18+
summary: Create an authorisation token
19+
tags:
20+
- Logged-in user

‎tests/test_openapi_parser.py‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
import unittest
2+
from webapp.openapi_parser import parse_openapi, read_yaml_from_file
3+
4+
5+
class TestOpenApiParser(unittest.TestCase):
6+
def test_openapi_parser(self):
7+
EXPECTED_OUTPUT = {
8+
"Logged-in user": [
9+
{
10+
"/account/op-create_authorisation_token": {
11+
"post": {
12+
"description": (
13+
"Create an authorisation OAuth token and "
14+
"OAuth consumer."
15+
),
16+
"operationId": (
17+
"AccountHandler_create_authorisation_token"
18+
),
19+
"responses": {
20+
"200": {
21+
"content": {
22+
"application/json": {
23+
"schema": {
24+
"additionalProperties": True,
25+
"type": "object",
26+
}
27+
}
28+
},
29+
"description": (
30+
"A JSON object containing: "
31+
"``token_key``, ``token_secret``, "
32+
"``consumer_key``, and ``name``."
33+
),
34+
}
35+
},
36+
"summary": "Create an authorisation token",
37+
"tags": ["Logged-in user"],
38+
}
39+
}
40+
}
41+
]
42+
}
43+
44+
definition = read_yaml_from_file("tests/openapi_example.yaml")
45+
output = parse_openapi(definition)
46+
self.assertEqual(output, EXPECTED_OUTPUT)
47+
48+
49+
if __name__ == "__main__":
50+
unittest.main()

0 commit comments

Comments
 (0)