Skip to content
Kessel

KesselK8SClusterService_CreateK8SCluster

POST
/api/inventory/v1beta1/resources/k8s-clusters

Request Body required

Section titled “Request Body required ”
object
k8s_cluster

The k8s cluster to create in Kessel Asset Inventory

object
metadata

Metadata about this resource

object
id

Kessel Asset Inventory generated identifier.

string
resource_type

The type of the Resource

string
created_at

Date and time when the inventory item was first reported.

string format: date-time
updated_at

Date and time when the inventory item was last updated.

string format: date-time
deleted_at

Date and time when the inventory item was deleted.

string format: date-time
org_id

The org id in which this resource is a member for access control. A resource can only be a member of one org.

string
workspace_id

The workspace id in which this resource is a member for access control. A resource can only be a member of one workspace.

string
labels
Array<object>
object
key
string
value
string
reporter_data

Write only reporter specific data

object
reporter_type
string format: enum
Allowed values: REPORTER_TYPE_UNSPECIFIED REPORTER_TYPE_OTHER ACM HBI OCM NOTIFICATIONS
reporter_instance_id

The ID of the instance of the reporter. This is derived from the authentication mechanism, i.e. authentication token.

string
console_href

The URL for this resource in the reporter’s management UI console. For example this would be the cluster URL in the HCC Console for an OCM reported cluster.

string
api_href

Reporter specific API link to the resource.

string
local_resource_id

The ID assigned to this resource by the reporter, for example OCM cluster ID, HBI’s host id, or ACM managed cluster name etc.

string
reporter_version

Version of the reporter

string
resource_data
object
external_cluster_id

The OCP cluster ID or ARN etc for *KS

string
cluster_status
string format: enum
Allowed values: CLUSTER_STATUS_UNSPECIFIED CLUSTER_STATUS_OTHER READY FAILED OFFLINE
cluster_reason
string
kube_version

The version of kubernetes

string
kube_vendor
string format: enum
Allowed values: KUBE_VENDOR_UNSPECIFIED KUBE_VENDOR_OTHER AKS EKS IKS OPENSHIFT GKE
vendor_version

The version of the productized kubernetes distribution

string
cloud_platform
string format: enum
Allowed values: CLOUD_PLATFORM_UNSPECIFIED CLOUD_PLATFORM_OTHER NONE_UPI BAREMETAL_IPI BAREMETAL_UPI AWS_IPI AWS_UPI AZURE_IPI AZURE_UPI IBMCLOUD_IPI IBMCLOUD_UPI KUBEVIRT_IPI OPENSTACK_IPI OPENSTACK_UPI GCP_IPI GCP_UPI NUTANIX_IPI NUTANIX_UPI VSPHERE_IPI VSPHERE_UPI OVIRT_IPI
nodes
Array<object>
object
name

The name of the node (this can contain private info)

string
cpu

CPU Capacity of the node defined in CPU units, e.g. “0.5”

string
memory

Memory Capacity of the node defined as MiB, e.g. “50Mi”

string
labels

Map of string keys and string values that can be used to organize and categorize (scope and select) resources Todo: Do we require at least 1 label?

Array<object>
object
key
string
value
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object

default

Section titled “default ”

Default error response

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any