Get a Kubernetes agent install script

get

https://api.cast.ai/v1/agent.sh

All parameters are optional. If no parameters are provided, then the script will default to EKS configuration.

The returned install script can be run in your terminal to install the CASTAI Kubernetes agent. The script can also be used to update an already running agent in your cluster.

The agent supports automatic discovery of cluster properties. However, if you specify at least one of the properties, then all properties for that provider must be specified.

OpenShift (ROSA) supports autodiscovery so choosing it does not require any OpenShift parameters. However, autodiscovery can be turned off by providing the properties explicitly. When any of the OpenShift parameters are provided, then all OpenShift parameters must be provided, with the exception of openshift.runAsUser, openshift.runAsGroup and openshift.fsGroup, which are optional and can be specified without the other parameters.

Query Params

eks.region

string

AWS region of your EKS cluster.

eks.accountId

string

Your AWS account id. Can be retrieved by executing aws sts get-caller-identity.

eks.clusterName

string

The name of your EKS cluster.

gke.region

string

GCP region of your GKE cluster.

gke.projectId

string

GCP project id in which your GKE cluster is created.

gke.clusterName

string

The name of your GKE cluster.

gke.location

string

Location of your GKE cluster.

gke.psc

boolean

Cluster to be connected via GCP Private Service Connect

provider

string

enum

Defaults to invalid_provider

Provider of the cluster.

Allowed:

kops.csp

string

enum

Defaults to invalid

The Cloud Service Provider (CSP) of your kOps cluster.

Possible values are: aws, gcp.

invalid: Invalid.
aws: Amazon web services.
gcp: Google cloud provider.
azure: Microsoft Azure.
unknown: Unknown.

kops.region

string

The region of your kOps cluster. Region is CSP specific.

kops.clusterName

string

The name of your kOps cluster.

kops.stateStore

string

The kOps cluster state store. Only remote S3 state is supported at the moment.

aks.location

string

Azure location of your AKS cluster.

aks.nodeResourceGroup

string

Azure resource group where AKS nodes are deployed.

aks.subscriptionId

string

Azure account subscription id.

openshift.csp

string

enum

Defaults to invalid

The Cloud Service Provider (CSP) of your OpenShift cluster.

Possible values are: aws.

invalid: Invalid.
aws: Amazon web services.
gcp: Google cloud provider.
azure: Microsoft Azure.
unknown: Unknown.

openshift.region

string

The region of your OpenShift cluster. Region is CSP specific.

openshift.clusterName

string

The name of your OpenShift cluster.

openshift.internalId

string

The OpenShift cluster ID. It can be found in the ClusterVersion object.

Link to docs.

openshift.runAsUser

string

The uid of the user that runs the agent pod.

openshift.runAsGroup

string

The gid of the user that runs the agent pod.

openshift.fsGroup

string

The gid of the user that owns the agent pod's volumes.

anywhere.clusterName

string

The name of your cluster.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The agent install script.

400Bad request. Additional details returned in the error response.