Returns single command for getting the script for one-pass onboarding.

get

https://api.cast.ai/v1/kubernetes/external-clusters/onboarding/connect-and-enable-castai-cmd

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

clusterName

string

Customer cluster name.

provider

string

Provider: eks, gke, aks, etc.

nvidiaDevicePlugin

boolean

Whether NVIDIA device plugin DaemonSet should be installed during Phase 2 on-boarding.

installSecurityAgent

boolean

Whether CAST AI Security Insights agent should be installed.

installAutoscalerAgent

boolean

Whether CAST AI Autoscaler components should be installed.
To enable backwards compatibility, when the field is omitted, it is defaulted to true.

installGpuMetricsExporter

boolean

Whether CAST AI GPU metrics exporter should be installed.

installAiOptimizerProxy

boolean

Whether CAST AI AI-Optimizer Proxy should be installed.

installNetflowExporter

boolean

Whether Netflow network exporter should be installed.

installWorkloadAutoscaler

boolean

Whether CAST AI Workload Autoscaler should be installed.

installPodMutator

boolean

Whether CAST AI Pod Mutator should be installed.

installOmni

boolean

Whether cluster should be onboarded with CAST AI Omni.

installOperator

boolean

Whether cluster should be onboarded with Castware Operator.

installSecurityImageScanning

boolean

Whether to install image scanning as part of security.
No-op if install_security_agent is set to false.
To enable backwards compatibility, when the field is omitted, it is defaulted to true.

installSecurityCompliance

boolean

Whether to install compliance scanning as part of security.
No-op if install_security_agent is set to false.
To enable backwards compatibility, when the field is omitted, it is defaulted to true.

useUmbrella

boolean

Whether to use umbrella Helm chart for onboarding.

useCastctl

boolean

Whether to use castctl to connect a cluster.
Deprecated. Use onboarding_path=ONBOARDING_PATH_CASTCTL.

onboardingPath

string

enum

Defaults to ONBOARDING_PATH_UNSPECIFIED

Installation method (script, helm, castctl, …).
Defaults to ONBOARDING_PATH_SCRIPT for backward compatibility.

Allowed:

installReliabilityMetrics

boolean

Whether CAST AI Reliability Metrics should be installed.

Response

200A successful response.