Skip to content

Commit e9c20e3

Browse files
committed
Proofreading & Duplication
1 parent 23d8365 commit e9c20e3

File tree

14 files changed

+1901
-3
lines changed

14 files changed

+1901
-3
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
title: End of life for personal installation templates
3+
excerpt: Information about the removal of your personal installation templates & workaround
4+
updated: 2025-04-29
5+
---
6+
7+
**This is an important documentation, please read it carefully as you might be impacted in the future if you request an OS installation on a new dedicated server or an OS reinstallation on a dedicated server you already have.**
8+
9+
Although this page outlines the decommissioning of personal templates for dedicated server OS installation and its impacts, customers can rest assured that **there will be no loss of features**.
10+
In fact, after this decommissioning, customers will still be able to install operating systems with **the same level of customization as before**. Moreover, customers who use the API directly will benefit from **1 simplified API call**.
11+
12+
## Objective
13+
14+
This page provides key information about the decommissioning plan for personal templates used in dedicated server OS installations. Additionally, it offers helpful tips for customers using the OVHcloud, SoYouStart, or Kimsufi Control Panels. Furthermore, it highlights the benefits of the new API call compared to the deprecated API call.
15+
16+
## Context<a name="context"></a>
17+
18+
OVHcloud is constantly evolving and must adapt its offers to the increasingly resilient and regulated cloud market. In order to meet those new challenges, **personal templates for dedicated servers OS installation** will be fully decommissioned on the **7th of October 2025**.
19+
20+
This feature allowed requesting an OS installation on a dedicated server by using a personal template containing the following elements:
21+
22+
- Operating system to be installed
23+
- Partitioning layout
24+
- Hardware RAID configuration
25+
- Hostname
26+
- SSH public key
27+
- Post-installation script
28+
29+
In order to simplify the OS installation on dedicated servers as well as the migration communication, a new API call was created: `POST /dedicated/server/{serviceName}/reinstall`{.action}. This API call is the successor of the old route: `POST /dedicated/server/{serviceName}/install/start`{.action}. The old route had the ability to target an OS installation from an OVHcloud template **or a personal template**.
30+
31+
The old route and the notion of personal templates will be decommissioned. The new route only supports starting an OS installation from an OVHcloud template. Also, please note that the term "OVHcloud template" will gradually disappear in favour of the more precise "operating system".
32+
33+
Personal templates decommissioning will be done in 2 steps:
34+
35+
### Step 1: 17th of June 2025<a name="step-1"></a>
36+
37+
- Customers will no longer be able to **edit** or **add** new personal templates.
38+
- Customers having personal templates and active subscriptions to dedicated servers will receive custom technical information by email to help them migrate their personal templates to the [new "/reinstall" API call](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/reinstall).
39+
40+
### Step 2: 7th of October 2025<a name="step-2"></a>
41+
42+
- Customers will no longer be able to access their personal templates.
43+
- All data related to personal templates will be deleted.
44+
45+
Please note that customers will still have the email from the 17th of June 2025 with technical documentation based on their personal templates data to help them migrate to the new API call.
46+
47+
## Instructions <a name="instructions"></a>
48+
49+
The following section contains specific information for all customers with an account at OVHcloud, SoYouStart or Kimsufi and whether you are currently using the OVHcloud Control Panel or the API to install OSs on your dedicated server.
50+
51+
### Using the OVHcloud, SoYouStart or Kimsufi Control Panels<a name="ux"></a>
52+
53+
The `Install one of your templates`{.action} wizard to install an operating system on a dedicated server has already been removed since mid-April 2025. If you were using that wizard you have 3 long-term possibilities:
54+
55+
- Keep using the Web interface (not recommended if you plan on automating your OS installations): Apply all customizations in the OS install wizard manually (former `Install from an OVHcloud template`{.action} wizard) every time you need to perform an installation.
56+
- Write a script that uses the API (best for automation, but requires programming skills): See the section [Using OVHcloud, SoYouStart or Kimsufi API](#api) below.
57+
- Use the API console (good tradeoff): Use the old API call until the 17th of June 2025 and then use the new API call with the provided payloads.
58+
59+
Although you could start exploring the examples and schemes of the [new "/reinstall" API call in the API console](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/reinstall) and look at its [public documentation](/pages/bare_metal_cloud/dedicated_servers/api-os-installation), here is the temporary workaround you can follow until you receive the payloads for the new API route via email on the 17th of June 2025.
60+
61+
#### OVHcloud workaround <a name="ux-ovh"></a>
62+
63+
As mentioned in the [OVHcloud API documentation](/pages/manage_and_operate/api/first-steps#sign-in-to-ovhcloud-apis), on the [OVHcloud console API](https://eu.api.ovh.com/console/) page:
64+
65+
- Click `Authentication`{.action} in the upper left corner.
66+
- Select `Login with OVHcloud SSO`{.action}.
67+
- Enter your OVHcloud credentials.
68+
- Click `Authorize`{.action} to allow performing API calls through the console.
69+
70+
![API](/pages/manage_and_operate/api/first-steps/images/login.png){.thumbnail}
71+
72+
Then run the API call to trigger an OS installation from your personal template:
73+
74+
- Select `v1`{.action}.
75+
- Choose the `/dedicated/server`{.action} section.
76+
- Find the `POST /dedicated/server/{serviceName}/install/start`{.action} API call (you can use the filter).
77+
- In the `serviceName` field, enter the name of the dedicated server you want to install.
78+
- In the `REQUEST BODY` field (aka API payload), put the following JSON value (in this example we assume that "my-amazing-template" is the name of the personal template you want to install):
79+
80+
```json
81+
{
82+
"templateName": "my-amazing-template"
83+
}
84+
```
85+
86+
If you need to list your personal templates and their details, please go to the `/me`{.action} section and look at all the `GET` API calls under `/me/installationTemplate`{.action}.
87+
88+
> [!alert]
89+
> **Executing the call [POST /dedicated/server/{serviceName}/install/start](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/install/start) to a dedicated server will erase all the data on that server. PLEASE BE CAREFUL WHILE USING THIS API CALL.**
90+
>
91+
92+
Then click the `Execute`{.action} button to start the OS installation.
93+
94+
![console API](images/screenshot-api-console-workaround.png){.thumbnail}
95+
96+
You can go back to the [OVHcloud Control Panel](/links/manager) on the dedicated server dashboard page to track the installation progress.
97+
98+
#### SoYouStart or Kimsufi workarounds <a name="ux-sys-ks"></a>
99+
100+
Open the [SoYouStart API console](https://eu.api.soyoustart.com/console/) or the [Kimsufi API console](https://eu.api.kimsufi.com/console/).
101+
102+
Click `Login`{.action} on the top right corner and enter your credentials. Then click the `Log in`{.action} button: you are now authenticated with the API console.
103+
104+
- Open the `/dedicated/server`{.action} section.
105+
- Find the `POST /dedicated/server/{serviceName}/install/start`{.action} API call.
106+
- In the `serviceName` field, enter the name of the dedicated server you want to install.
107+
- In the `templateName` field, enter the name of the personal template you want to install.
108+
109+
If you need to list your personal templates and their details, please go to the `/me`{.action} section and look at all the `GET` API calls under `/me/installationTemplate`{.action}.
110+
111+
> [!alert]
112+
> **Executing the call [POST /dedicated/server/{serviceName}/install/start](https://eu.api.soyoustart.com/console/#/dedicated/server/%7BserviceName%7D/install/start~POST) (or [this call](https://eu.api.kimsufi.com/console/#/dedicated/server/%7BserviceName%7D/install/start~POST) for Kimsufi) to a dedicated server will erase all the data on that server. PLEASE BE CAREFUL WHILE USING THIS API CALL.**
113+
>
114+
115+
Then click the `Execute`{.action} button to start the OS installation.
116+
117+
You can go back to the [SoYouStart](https://eu.soyoustart.com/manager) or [Kimsufi Control Panel](https://www.kimsufi.com/fr/manager) on the dedicated server dashboard page to track the installation progress.
118+
119+
### Using OVHcloud, SoYouStart or Kimsufi APIs <a name="api"></a>
120+
121+
If you are using the OVHcloud, SoYouStart or Kimsufi APIs to trigger OS installations from a personal template, you can continue using the `POST /dedicated/server/{serviceName}/install/start`{.action} API call until **the 7th of October 2025**.
122+
But please note that starting from **the 17th of June 2025**, you will no longer be able to add or edit personal templates.
123+
124+
Although you will receive an email with all the details to migrate your API payloads to the [new "/reinstall" API call](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/reinstall), feel free to start exploring the examples and schemes of the [new /reinstall API call in the API console](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/reinstall) (API scheme is the same for OVHcloud, [SoYouStart](https://eu.api.soyoustart.com/console/#/dedicated/server/%7BserviceName%7D/install/start~POST) and [Kimsufi](https://eu.api.kimsufi.com/console/#/dedicated/server/%7BserviceName%7D/install/start~POST)) and look at its [public documentation](/pages/bare_metal_cloud/dedicated_servers/api-os-installation).
125+
126+
The end of the personal templates feature will simplify OS installation on dedicated servers. Indeed, the new API call [POST /dedicated/server/{serviceName}/reinstall](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/reinstall) brings all the possible customizations that the old API call [POST /dedicated/server/{serviceName}/install/start](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/install/start) was not able to offer without the need to first define a personal template under [/me/installationTemplate](https://eu.api.ovh.com/console/?section=%2Fme&branch=v1#get-/me/installationTemplate).
127+
128+
The following comparison gives you an idea of the reduced number of API calls to achieve a complex customization configuration involving hardware RAID and custom partitioning: from `4+n`{.action} calls (where `n`{.action} is the number of partitions you have defined in your partitioning layout) to 1 single API call.
129+
130+
![API calls comparison](images/api-calls-comparison.png){.thumbnail}
131+
132+
As you can see, everything becomes streamlined, eliminating the the need for heavy setups.
133+
134+
## Go further
135+
136+
[Getting started with a dedicated server](/pages/bare_metal_cloud/dedicated_servers/getting-started-with-dedicated-server)
137+
138+
[Getting started with a Kimsufi, So You Start or Rise dedicated server](/pages/bare_metal_cloud/dedicated_servers/getting-started-with-dedicated-server-eco)
139+
140+
[First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps)
141+
142+
[OVHcloud API & OS installation](/pages/bare_metal_cloud/dedicated_servers/api-os-installation)
143+
144+
[OVHcloud API and Storage](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh)
145+
146+
Join our [community of users](/links/community).

0 commit comments

Comments
 (0)