Skip to content

Commit a8b9dce

Browse files
committed
feat(bare_metal_cloud/dedicated_servers): add end-of-life-for-personal-installation-templates
ref: #PUBM-45215
1 parent 50613b1 commit a8b9dce

File tree

6 files changed

+273
-0
lines changed

6 files changed

+273
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: End of life for personal installation templates
3+
excerpt: Information about removal of your personal installation templates & workaround
4+
updated: 2025-04-29
5+
---
6+
7+
**This is an important piece of information, please read the entire message 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+
## Context<a name="context"></a>
10+
11+
OVHcloud is constantly evolving and must adapt its offerings 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**.
12+
13+
This feature allowed requesting an OS installation on a dedicated server by using a personal template containing with following elements:
14+
- operating system to be installed
15+
- partitioning layout,
16+
- hardware RAID configuration,
17+
- hostname,
18+
- SSH public key,
19+
- post-installation script.
20+
21+
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**.
22+
23+
The old route and the notion of personal templates will be decommissioned in future. The new route only supports starting an OS installation from an OVHcloud template. Also, please note that the confusing "OVHcloud template" terminology will gradually disappear in favor of "operating system".
24+
25+
Personal templates decommissioning will be done in 2 steps:
26+
27+
### Step 1: 17th of June 2025<a name="step-1"></a>
28+
29+
- Customers will no longer be able to **edit** or **add** new personal templates.
30+
- Customers having personal template(s) and active subscriptions to dedicated servers will receive custom technical information by email to help them migrate their personal template(s) to the [new /reinstall API call](https://eu.api.ovh.com/console/?section=%2Fdedicated%2Fserver&branch=v1#post-/dedicated/server/-serviceName-/reinstall).
31+
32+
### Step 2: 7th of October 2025<a name="step-2"></a>
33+
34+
- Customers will no longer be able to access their personal templates.
35+
- All data related to personal templates will be deleted.
36+
37+
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.
38+
39+
## Instructions<a name="instructions"></a>
40+
41+
The following section contains specific information depending on whether you have an OVHcloud, SoYouStart or Kimsufi account and whether you are currently using the control panel or the API to install OSes on your dedicated server.
42+
43+
### Using OVHcloud, SoYouStart or Kimsufi Control Panel<a name="ux"></a>
44+
45+
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:
46+
- keep using the Web interface (not recommended if you plan to automate your OS installations): manually apply all customizations in the OS install wizard (former `Install from an OVHcloud template`{.action} wizard) every time you need to perform an installation,
47+
- write a script that uses the API (best for automation, but requires programming skills): see section [Using OVHcloud, SoYouStart or Kimsufi API](#api) below,
48+
- use the API console (good tradeoff): use old API call until the 17th of June 2025 and then use new API call with provided payloads.
49+
50+
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 your receive the payloads for the new API route in the email of the 17th of June 2025.
51+
52+
#### OVHcloud workaround<a name="ux-ovh"></a>
53+
54+
As mentioned in the [OVHcloud APIs 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:
55+
- Click `Authentication`{.action} in the upper left.
56+
- Select `Login with OVHcloud SSO`{.action}.
57+
- Enter your OVHcloud credentials.
58+
- Click `Authorize`{.action} to allow performing API calls through the console.
59+
60+
![API](/pages/manage_and_operate/api/first-steps/images/login.png){.thumbnail}
61+
62+
Then run the API call to trigger an OS installation from your personal template:
63+
- Select `v1`{.action}.
64+
- Choose `/dedicated/server`{.action} section.
65+
- Find `POST /dedicated/server/{serviceName}/install/start`{.action} API call (you can use the filter).
66+
- In the `serviceName` field, enter the name of the dedicated server you want to install.
67+
- 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):
68+
```json
69+
{
70+
"templateName": "my-amazing-template"
71+
}
72+
```
73+
74+
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}.
75+
76+
> [!warning]
77+
> **Performing a [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 in that server. PLEASE BE CAREFUL WHILE USING THIS API CALL.**
78+
>
79+
80+
Then click the `Execute`{.action} button to start the OS installation.
81+
82+
![console API](images/screenshot-api-console-workaround.png){.thumbnail}
83+
84+
You can go back to the [OVHcloud Control Panel](/links/manager) on the dedicated server dashboard page to track the installation progress.
85+
86+
#### SoYouStart or Kimsufi workarounds<a name="ux-sys-ks"></a>
87+
88+
Open the [SoYouStart console API](https://eu.api.soyoustart.com/console/) or the [Kimsufi console API](https://eu.api.kimsufi.com/console/).
89+
90+
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.
91+
92+
- Open the `/dedicated/server`{.action} section.
93+
- Find the `POST /dedicated/server/{serviceName}/install/start`{.action} API call.
94+
- In the `serviceName` field, enter the name of the dedicated server you want to install.
95+
- In the `templateName` field, enter the name of the personal template you want to install.
96+
97+
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}.
98+
99+
> [!warning]
100+
> **Performing a [POST /dedicated/server/{serviceName}/install/start](https://eu.api.soyoustart.com/console/#/dedicated/server/%7BserviceName%7D/install/start~POST) (or [here](https://eu.api.kimsufi.com/console/#/dedicated/server/%7BserviceName%7D/install/start~POST) for Kimsufi) to a dedicated server will erase all the data in that server. PLEASE BE CAREFUL WHILE USING THIS API CALL.**
101+
>
102+
103+
Then click the `Execute`{.action} button to start the OS installation.
104+
105+
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.
106+
107+
### Using OVHcloud, SoYouStart or Kimsufi APIs<a name="api"></a>
108+
109+
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**.
110+
But please note that starting from **the 17th of June 2025**, you will no longer be able to add or edit personal templates.
111+
112+
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).
113+
114+
In your case, the end of the personal templates feature should 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).
115+
116+
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.
117+
118+
![API calls comparison](images/api-calls-comparison.png){.thumbnail}
119+
120+
As you can see, everything becomes streamlined, eliminating the the need for heavy setup.
121+
122+
## Go further
123+
124+
[Getting started with a dedicated server](/pages/bare_metal_cloud/dedicated_servers/getting-started-with-dedicated-server)
125+
126+
[Getting started with a Kimsufi, So You Start or Rise dedicated server](/pages/bare_metal_cloud/dedicated_servers/getting-started-with-dedicated-server-eco)
127+
128+
[First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps)
129+
130+
[OVHcloud API & OS installation](/pages/bare_metal_cloud/dedicated_servers/api-os-installation)
131+
132+
[OVHcloud API and Storage](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh)
133+
134+
Join our [community of users](/links/community).

0 commit comments

Comments
 (0)