Install vcluster
curl --request POST \
--url https://{host}/api/supervisors/{name}/vcluster/install \
--header 'Content-Type: application/json' \
--cookie k8s-gate-session= \
--data '
{
"chartVersion": "<string>",
"enableIngress": true,
"enableOidc": true,
"enableServiceMonitor": true,
"exportKubeConfig": true,
"highAvailability": true,
"ingressHost": "<string>",
"instanceName": "<string>",
"integrateCertManager": true,
"integrateKubeVirt": true,
"integrateMetricsServer": true,
"k8sVersion": "<string>",
"namespace": "<string>",
"oidcClientSecret": "<string>",
"oidcGroupsClaim": "<string>",
"oidcUsernameClaim": "<string>",
"resourceProfile": "<string>",
"serviceType": "<string>",
"storageClassName": "<string>",
"storageSize": "<string>"
}
'import requests
url = "https://{host}/api/supervisors/{name}/vcluster/install"
payload = {
"chartVersion": "<string>",
"enableIngress": True,
"enableOidc": True,
"enableServiceMonitor": True,
"exportKubeConfig": True,
"highAvailability": True,
"ingressHost": "<string>",
"instanceName": "<string>",
"integrateCertManager": True,
"integrateKubeVirt": True,
"integrateMetricsServer": True,
"k8sVersion": "<string>",
"namespace": "<string>",
"oidcClientSecret": "<string>",
"oidcGroupsClaim": "<string>",
"oidcUsernameClaim": "<string>",
"resourceProfile": "<string>",
"serviceType": "<string>",
"storageClassName": "<string>",
"storageSize": "<string>"
}
headers = {
"cookie": "k8s-gate-session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'k8s-gate-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
chartVersion: '<string>',
enableIngress: true,
enableOidc: true,
enableServiceMonitor: true,
exportKubeConfig: true,
highAvailability: true,
ingressHost: '<string>',
instanceName: '<string>',
integrateCertManager: true,
integrateKubeVirt: true,
integrateMetricsServer: true,
k8sVersion: '<string>',
namespace: '<string>',
oidcClientSecret: '<string>',
oidcGroupsClaim: '<string>',
oidcUsernameClaim: '<string>',
resourceProfile: '<string>',
serviceType: '<string>',
storageClassName: '<string>',
storageSize: '<string>'
})
};
fetch('https://{host}/api/supervisors/{name}/vcluster/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/supervisors/{name}/vcluster/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chartVersion' => '<string>',
'enableIngress' => true,
'enableOidc' => true,
'enableServiceMonitor' => true,
'exportKubeConfig' => true,
'highAvailability' => true,
'ingressHost' => '<string>',
'instanceName' => '<string>',
'integrateCertManager' => true,
'integrateKubeVirt' => true,
'integrateMetricsServer' => true,
'k8sVersion' => '<string>',
'namespace' => '<string>',
'oidcClientSecret' => '<string>',
'oidcGroupsClaim' => '<string>',
'oidcUsernameClaim' => '<string>',
'resourceProfile' => '<string>',
'serviceType' => '<string>',
'storageClassName' => '<string>',
'storageSize' => '<string>'
]),
CURLOPT_COOKIE => "k8s-gate-session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/supervisors/{name}/vcluster/install"
payload := strings.NewReader("{\n \"chartVersion\": \"<string>\",\n \"enableIngress\": true,\n \"enableOidc\": true,\n \"enableServiceMonitor\": true,\n \"exportKubeConfig\": true,\n \"highAvailability\": true,\n \"ingressHost\": \"<string>\",\n \"instanceName\": \"<string>\",\n \"integrateCertManager\": true,\n \"integrateKubeVirt\": true,\n \"integrateMetricsServer\": true,\n \"k8sVersion\": \"<string>\",\n \"namespace\": \"<string>\",\n \"oidcClientSecret\": \"<string>\",\n \"oidcGroupsClaim\": \"<string>\",\n \"oidcUsernameClaim\": \"<string>\",\n \"resourceProfile\": \"<string>\",\n \"serviceType\": \"<string>\",\n \"storageClassName\": \"<string>\",\n \"storageSize\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "k8s-gate-session=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/api/supervisors/{name}/vcluster/install")
.header("cookie", "k8s-gate-session=")
.header("Content-Type", "application/json")
.body("{\n \"chartVersion\": \"<string>\",\n \"enableIngress\": true,\n \"enableOidc\": true,\n \"enableServiceMonitor\": true,\n \"exportKubeConfig\": true,\n \"highAvailability\": true,\n \"ingressHost\": \"<string>\",\n \"instanceName\": \"<string>\",\n \"integrateCertManager\": true,\n \"integrateKubeVirt\": true,\n \"integrateMetricsServer\": true,\n \"k8sVersion\": \"<string>\",\n \"namespace\": \"<string>\",\n \"oidcClientSecret\": \"<string>\",\n \"oidcGroupsClaim\": \"<string>\",\n \"oidcUsernameClaim\": \"<string>\",\n \"resourceProfile\": \"<string>\",\n \"serviceType\": \"<string>\",\n \"storageClassName\": \"<string>\",\n \"storageSize\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/supervisors/{name}/vcluster/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'k8s-gate-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"chartVersion\": \"<string>\",\n \"enableIngress\": true,\n \"enableOidc\": true,\n \"enableServiceMonitor\": true,\n \"exportKubeConfig\": true,\n \"highAvailability\": true,\n \"ingressHost\": \"<string>\",\n \"instanceName\": \"<string>\",\n \"integrateCertManager\": true,\n \"integrateKubeVirt\": true,\n \"integrateMetricsServer\": true,\n \"k8sVersion\": \"<string>\",\n \"namespace\": \"<string>\",\n \"oidcClientSecret\": \"<string>\",\n \"oidcGroupsClaim\": \"<string>\",\n \"oidcUsernameClaim\": \"<string>\",\n \"resourceProfile\": \"<string>\",\n \"serviceType\": \"<string>\",\n \"storageClassName\": \"<string>\",\n \"storageSize\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"steps": [
{
"action": "<string>",
"kind": "<string>",
"name": "<string>"
}
],
"message": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}capi
Install vcluster
Wizard-native vCluster (Step 8) — loft-sh/vcluster Shared Nodes mode.
Authorisation: vcluster:Install on krn:celum:supervisor:{name}:vcluster:*.
POST
/
api
/
supervisors
/
{name}
/
vcluster
/
install
Install vcluster
curl --request POST \
--url https://{host}/api/supervisors/{name}/vcluster/install \
--header 'Content-Type: application/json' \
--cookie k8s-gate-session= \
--data '
{
"chartVersion": "<string>",
"enableIngress": true,
"enableOidc": true,
"enableServiceMonitor": true,
"exportKubeConfig": true,
"highAvailability": true,
"ingressHost": "<string>",
"instanceName": "<string>",
"integrateCertManager": true,
"integrateKubeVirt": true,
"integrateMetricsServer": true,
"k8sVersion": "<string>",
"namespace": "<string>",
"oidcClientSecret": "<string>",
"oidcGroupsClaim": "<string>",
"oidcUsernameClaim": "<string>",
"resourceProfile": "<string>",
"serviceType": "<string>",
"storageClassName": "<string>",
"storageSize": "<string>"
}
'import requests
url = "https://{host}/api/supervisors/{name}/vcluster/install"
payload = {
"chartVersion": "<string>",
"enableIngress": True,
"enableOidc": True,
"enableServiceMonitor": True,
"exportKubeConfig": True,
"highAvailability": True,
"ingressHost": "<string>",
"instanceName": "<string>",
"integrateCertManager": True,
"integrateKubeVirt": True,
"integrateMetricsServer": True,
"k8sVersion": "<string>",
"namespace": "<string>",
"oidcClientSecret": "<string>",
"oidcGroupsClaim": "<string>",
"oidcUsernameClaim": "<string>",
"resourceProfile": "<string>",
"serviceType": "<string>",
"storageClassName": "<string>",
"storageSize": "<string>"
}
headers = {
"cookie": "k8s-gate-session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'k8s-gate-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
chartVersion: '<string>',
enableIngress: true,
enableOidc: true,
enableServiceMonitor: true,
exportKubeConfig: true,
highAvailability: true,
ingressHost: '<string>',
instanceName: '<string>',
integrateCertManager: true,
integrateKubeVirt: true,
integrateMetricsServer: true,
k8sVersion: '<string>',
namespace: '<string>',
oidcClientSecret: '<string>',
oidcGroupsClaim: '<string>',
oidcUsernameClaim: '<string>',
resourceProfile: '<string>',
serviceType: '<string>',
storageClassName: '<string>',
storageSize: '<string>'
})
};
fetch('https://{host}/api/supervisors/{name}/vcluster/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/supervisors/{name}/vcluster/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chartVersion' => '<string>',
'enableIngress' => true,
'enableOidc' => true,
'enableServiceMonitor' => true,
'exportKubeConfig' => true,
'highAvailability' => true,
'ingressHost' => '<string>',
'instanceName' => '<string>',
'integrateCertManager' => true,
'integrateKubeVirt' => true,
'integrateMetricsServer' => true,
'k8sVersion' => '<string>',
'namespace' => '<string>',
'oidcClientSecret' => '<string>',
'oidcGroupsClaim' => '<string>',
'oidcUsernameClaim' => '<string>',
'resourceProfile' => '<string>',
'serviceType' => '<string>',
'storageClassName' => '<string>',
'storageSize' => '<string>'
]),
CURLOPT_COOKIE => "k8s-gate-session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/supervisors/{name}/vcluster/install"
payload := strings.NewReader("{\n \"chartVersion\": \"<string>\",\n \"enableIngress\": true,\n \"enableOidc\": true,\n \"enableServiceMonitor\": true,\n \"exportKubeConfig\": true,\n \"highAvailability\": true,\n \"ingressHost\": \"<string>\",\n \"instanceName\": \"<string>\",\n \"integrateCertManager\": true,\n \"integrateKubeVirt\": true,\n \"integrateMetricsServer\": true,\n \"k8sVersion\": \"<string>\",\n \"namespace\": \"<string>\",\n \"oidcClientSecret\": \"<string>\",\n \"oidcGroupsClaim\": \"<string>\",\n \"oidcUsernameClaim\": \"<string>\",\n \"resourceProfile\": \"<string>\",\n \"serviceType\": \"<string>\",\n \"storageClassName\": \"<string>\",\n \"storageSize\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "k8s-gate-session=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/api/supervisors/{name}/vcluster/install")
.header("cookie", "k8s-gate-session=")
.header("Content-Type", "application/json")
.body("{\n \"chartVersion\": \"<string>\",\n \"enableIngress\": true,\n \"enableOidc\": true,\n \"enableServiceMonitor\": true,\n \"exportKubeConfig\": true,\n \"highAvailability\": true,\n \"ingressHost\": \"<string>\",\n \"instanceName\": \"<string>\",\n \"integrateCertManager\": true,\n \"integrateKubeVirt\": true,\n \"integrateMetricsServer\": true,\n \"k8sVersion\": \"<string>\",\n \"namespace\": \"<string>\",\n \"oidcClientSecret\": \"<string>\",\n \"oidcGroupsClaim\": \"<string>\",\n \"oidcUsernameClaim\": \"<string>\",\n \"resourceProfile\": \"<string>\",\n \"serviceType\": \"<string>\",\n \"storageClassName\": \"<string>\",\n \"storageSize\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/supervisors/{name}/vcluster/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'k8s-gate-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"chartVersion\": \"<string>\",\n \"enableIngress\": true,\n \"enableOidc\": true,\n \"enableServiceMonitor\": true,\n \"exportKubeConfig\": true,\n \"highAvailability\": true,\n \"ingressHost\": \"<string>\",\n \"instanceName\": \"<string>\",\n \"integrateCertManager\": true,\n \"integrateKubeVirt\": true,\n \"integrateMetricsServer\": true,\n \"k8sVersion\": \"<string>\",\n \"namespace\": \"<string>\",\n \"oidcClientSecret\": \"<string>\",\n \"oidcGroupsClaim\": \"<string>\",\n \"oidcUsernameClaim\": \"<string>\",\n \"resourceProfile\": \"<string>\",\n \"serviceType\": \"<string>\",\n \"storageClassName\": \"<string>\",\n \"storageSize\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"steps": [
{
"action": "<string>",
"kind": "<string>",
"name": "<string>"
}
],
"message": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
sessionCookiebearerToken
The session cookie issued by the OIDC sign-in flow. This is what a browser uses.
Path Parameters
The supervisor's name, as registered under Administration → Supervisors.
Body
application/json