Home / API Documentation / Platform management / Clusters / Management of machinery / Add Machine

Add Machine

Requests

HTTP request

POST /apis/platform.tkestack.io/v1/machines

create a Machine

Query parameters

Name	Type	Required	Description
dryRun	string	False	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldManager	string	False	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
pretty	string	False	If 'true', then the output is pretty printed.

Request body

Content-Type */*

Sample request

Machine instance in Kubernetes cluster

{
   "apiVersion": "platform.tkestack.io/v1",
   "kind": "Machine",
   "metadata": {
     "annotations": {
       "cpaas.io/display-name": "192.168.0.105"
     },
     "name": "mc-192-168-0-105"
   },
   "spec": {
     "clusterName": "global",
     "displayName": "",
     "ip": "192.168.0.105",
     "ipv6": "",
     "networkDevice": "",
     "password": "cGFzc3dvcmQ=",
     "port": 22,
     "proxy": {},
     "publicIP": "",
     "role": "",
     "type": "Baremetal",
     "username": "root"
   }
 }

Parmeters

Name	Type	Required	Description
apiVersion	string	True	See common parameters
kind	string	True	See common parameters
metadata	object	True	See common parameters
spec	object	True	MachineSpec is a description of machine. Path: spec
spec.clusterName	string	True	cluster name Path: spec.clusterName
spec.displayName	string	True	displayName Path: spec.displayName
spec.ip	string	True	ip Path: spec.ip
spec.ipv6	string	True	ipv6 Path: spec.ipv6
spec.networkDevice	string	True	networkDevice Path: spec.networkDevice
spec.password	string (byte)	True	password Path: spec.password
spec.port	integer (int32)	True	port Path: spec.port
spec.proxy	object	True	MachineProxy is the proxy to connect Machine's ssh. Path: spec.proxy
spec.publicIP	string	True	publicIP Path: spec.publicIP
spec.role	string	True	master/node Path: spec.role
spec.type	string	True	type Path: spec.type
spec.username	string	True	user name Path: spec.username

Responses

Content-Type application/json, application/yaml, application/vnd.kubernetes.protobuf

Status code: 201

Created

Sample response