Skip to content

Commit 6fb97a8

Browse files
sibucansibucan
committed
Merge branch 'development' of github.com:linode/linode-api-docs into lke-labels
2 parents 1bb7287 + bcb8291 commit 6fb97a8

File tree

2 files changed

+136
-64
lines changed

2 files changed

+136
-64
lines changed

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Linode OpenAPI 3
22

3+
[![Build Status](https://travis-ci.com/linode/linode-api-docs.svg?branch=master)](https://travis-ci.com/linode/linode-api-docs)
4+
35
This is the Linode API OpenAPI 3 Schema
46

57
## Requirements

‎openapi.yaml

Lines changed: 134 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -6241,13 +6241,19 @@ paths:
62416241
- region
62426242
- k8s_version
62436243
- node_pools
6244-
allOf:
6245-
- $ref: '#/components/schemas/LKEClusterRequestBody'
6246-
- properties:
6247-
node_pools:
6248-
type: array
6249-
items:
6250-
$ref: '#/components/schemas/LKENodePoolRequestBody'
6244+
properties:
6245+
label:
6246+
$ref: '#/components/schemas/LKECluster/properties/label'
6247+
region:
6248+
$ref: '#/components/schemas/LKECluster/properties/region'
6249+
k8s_version:
6250+
$ref: '#/components/schemas/LKECluster/properties/k8s_version'
6251+
tags:
6252+
$ref: '#/components/schemas/LKECluster/properties/tags'
6253+
node_pools:
6254+
type: array
6255+
items:
6256+
$ref: '#/components/schemas/LKENodePoolRequestBody'
62516257
responses:
62526258
'200':
62536259
description: Kubernetes cluster creation has started.
@@ -6268,8 +6274,20 @@ paths:
62686274
"k8s_version": "1.16",
62696275
"tags": ["ecomm", "blogs"],
62706276
"node_pools": [
6271-
{ "type": "g6-standard-4", "count": 6},
6272-
{ "type": "g6-standard-8", "count": 3}
6277+
{
6278+
"type": "g6-standard-4",
6279+
"count": 6,
6280+
"disks": [
6281+
{
6282+
"size": 1028,
6283+
"type": "ext4"
6284+
}
6285+
]
6286+
},
6287+
{
6288+
"type": "g6-standard-8",
6289+
"count": 3
6290+
}
62736291
]
62746292
}' \
62756293
https://api.linode.com/v4/lke/clusters
@@ -6279,7 +6297,7 @@ paths:
62796297
--label cluster12345 \
62806298
--region us-central \
62816299
--k8s_version 1.16 \
6282-
--node_pools.type g6-standard-4 --node_pools.count 6 \
6300+
--node_pools.type g6-standard-4 --node_pools.count 6 --node_pools.disks '[{"size": 1028, "type": "ext4"}]' \
62836301
--node_pools.type g6-standard-8 --node_pools.count 3 \
62846302
--tags ecomm
62856303
/lke/clusters/{clusterId}:
@@ -6339,7 +6357,7 @@ paths:
63396357
schema:
63406358
properties:
63416359
label:
6342-
$ref: '#/components/schemas/LKEClusterRequestBody/properties/label'
6360+
$ref: '#/components/schemas/LKECluster/properties/label'
63436361
tags:
63446362
type: array
63456363
items:
@@ -6362,7 +6380,6 @@ paths:
63626380
label:
63636381
$ref: '#/components/schemas/LKECluster/properties/label'
63646382
tags:
6365-
x-linode-filterable: true
63666383
type: array
63676384
items:
63686385
type: string
@@ -6533,7 +6550,18 @@ paths:
65336550
content:
65346551
application/json:
65356552
schema:
6536-
$ref: '#/components/schemas/LKENodePool'
6553+
type: object
6554+
properties:
6555+
type:
6556+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
6557+
count:
6558+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
6559+
disks:
6560+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
6561+
id:
6562+
$ref: '#/components/schemas/LKENodePool/properties/id'
6563+
nodes:
6564+
$ref: '#/components/schemas/LKENodePool/properties/nodes'
65376565
default:
65386566
$ref: '#/components/responses/ErrorResponse'
65396567
x-code-samples:
@@ -6543,14 +6571,21 @@ paths:
65436571
-H "Authorization: Bearer $TOKEN" \
65446572
-X POST -d '{
65456573
"type": "g6-standard-4",
6546-
"count": 6
6574+
"count": 6,
6575+
"disks": [
6576+
{
6577+
"size": 1028,
6578+
"type": "ext4"
6579+
}
6580+
]
65476581
}' \
65486582
https://api.linode.com/v4/lke/clusters/12345/pools
65496583
- lang: CLI
65506584
source: >
65516585
linode-cli lke pool-create 12345 \
65526586
--type g6-standard-4 \
65536587
--count 6 \
6588+
--disks '[{"size": 1028, "type": "ext4"}]'
65546589
/lke/clusters/{clusterId}/pools/{poolId}:
65556590
parameters:
65566591
- name: clusterId
@@ -6584,7 +6619,18 @@ paths:
65846619
content:
65856620
application/json:
65866621
schema:
6587-
$ref: '#/components/schemas/LKENodePool'
6622+
type: object
6623+
properties:
6624+
type:
6625+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
6626+
count:
6627+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
6628+
disks:
6629+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
6630+
id:
6631+
$ref: '#/components/schemas/LKENodePool/properties/id'
6632+
nodes:
6633+
$ref: '#/components/schemas/LKENodePool/properties/nodes'
65886634
x-code-samples:
65896635
- lang: Shell
65906636
source: >
@@ -6621,7 +6667,18 @@ paths:
66216667
content:
66226668
application/json:
66236669
schema:
6624-
$ref: '#/components/schemas/LKENodePool'
6670+
type: object
6671+
properties:
6672+
type:
6673+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
6674+
count:
6675+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
6676+
disks:
6677+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
6678+
id:
6679+
$ref: '#/components/schemas/LKENodePool/properties/id'
6680+
nodes:
6681+
$ref: '#/components/schemas/LKENodePool/properties/nodes'
66256682
x-code-samples:
66266683
- lang: Shell
66276684
source: >
@@ -14001,6 +14058,7 @@ components:
1400114058
The tag portion of a CAA record. It is invalid to set this on
1400214059
other record types.
1400314060
example: null
14061+
x-linode-filterable: true
1400414062
created:
1400514063
type: string
1400614064
format: date-time
@@ -14159,6 +14217,7 @@ components:
1415914217
The action that caused this Event. New actions may be added in the future.
1416014218
example: ticket_create
1416114219
x-linode-cli-display: 3
14220+
x-linode-filterable: true
1416214221
created:
1416314222
type: string
1416414223
readOnly: true
@@ -15922,10 +15981,28 @@ components:
1592215981
The number of GPUs this Linode Type offers.
1592315982
example: 0
1592415983
x-linode-cli-display: 11
15925-
LKEClusterRequestBody:
15984+
LKECluster:
1592615985
type: object
1592715986
description: A Kubernetes cluster.
1592815987
properties:
15988+
id:
15989+
type: integer
15990+
description: This Kubernetes cluster's unique ID.
15991+
readOnly: true
15992+
x-linode-cli-display: 1
15993+
example: 1234
15994+
created:
15995+
type: string
15996+
format: date-time
15997+
description: When this Kubernetes cluster was created.
15998+
example: "2019-09-12T21:25:30Z"
15999+
readOnly: true
16000+
updated:
16001+
type: string
16002+
format: date-time
16003+
description: When this Kubernetes cluster was updated.
16004+
example: "2019-09-13T21:24:16Z"
16005+
readOnly: true
1592916006
label:
1593016007
type: string
1593116008
description: >
@@ -15949,10 +16026,12 @@ components:
1594916026
# Kubernetes does NOT allow underscores in resource names and we are
1595016027
# passing this name to Kubernetes. Thus the following pattern:
1595116028
pattern: '[a-zA-Z0-9-]{3, 32}'
16029+
x-linode-cli-display: 2
1595216030
example: lkecluster12345
1595316031
region:
1595416032
type: string
1595516033
description: This Kubernetes cluster's location.
16034+
x-linode-cli-display: 3
1595616035
example: us-central
1595716036
k8s_version:
1595816037
type: string
@@ -15961,59 +16040,16 @@ components:
1596116040
and the latest supported patch version will be deployed.
1596216041
example: "1.16"
1596316042
tags:
16043+
x-linode-filterable: true
1596416044
type: array
1596516045
description: >
15966-
An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.
16046+
An array of tags applied to the Kubernetes cluster.
16047+
Tags are for organizational purposes only.
1596716048
items:
1596816049
type: string
1596916050
example:
1597016051
- ecomm
1597116052
- blogs
15972-
required:
15973-
- label
15974-
- region
15975-
- k8s_version
15976-
LKECluster:
15977-
type: object
15978-
# Note that LKECluster inherits all properties of
15979-
# LKEClusterRequestBody and then overrides some of the sub-properties
15980-
allOf:
15981-
- $ref: '#/components/schemas/LKEClusterRequestBody'
15982-
properties:
15983-
id:
15984-
type: integer
15985-
description: This Kubernetes cluster's unique ID.
15986-
readOnly: true
15987-
x-linode-cli-display: 1
15988-
example: 1234
15989-
created:
15990-
type: string
15991-
format: date-time
15992-
description: When this Kubernetes cluster was created.
15993-
example: "2019-09-12T21:25:30Z"
15994-
readOnly: true
15995-
updated:
15996-
type: string
15997-
format: date-time
15998-
description: When this Kubernetes cluster was updated.
15999-
example: "2019-09-13T21:24:16Z"
16000-
readOnly: true
16001-
# Note that these properties override some of the sub-properties from
16002-
# LKEClusterRequestBody but otherwise inherit all of the original
16003-
# sub-properties.
16004-
label:
16005-
x-linode-cli-display: 2
16006-
example: lkecluster12345
16007-
region:
16008-
readOnly: true
16009-
x-linode-cli-display: 3
16010-
example: us-central
16011-
k8s_version:
16012-
example: "1.16"
16013-
tags:
16014-
example:
16015-
- ecomm
16016-
- blogs
1601716053
LKENodePoolRequestBody:
1601816054
type: object
1601916055
description: >
@@ -16023,19 +16059,53 @@ components:
1602316059
type:
1602416060
type: string
1602516061
description: A Linode Type for all of the nodes in the Node Pool.
16026-
example: "g6-standard-4"
16062+
example: g6-standard-4
1602716063
count:
1602816064
type: integer
1602916065
description: The number of nodes in the Node Pool.
1603016066
minimum: 1
1603116067
maximum: 100
1603216068
example: 6
16069+
disks:
16070+
type: array
16071+
description: >
16072+
This Node Pool's custom disk layout. Each item in this array will create a new disk
16073+
partition for each node in this Node Pool.
16074+
16075+
* The custom disk layout is applied to each node in this Node Pool.
16076+
* The maximum number of custom disk partitions that can be configured is 7.
16077+
* Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
16078+
* A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.
16079+
16080+
**Note**: If this field is omitted, the node will have a default disk layout consisting of a single partition.
16081+
A custom layout is only required for specific use cases.
16082+
items:
16083+
type: object
16084+
description: >
16085+
The values to assign to each partition in this Node Pool's custom disk layout.
16086+
properties:
16087+
size:
16088+
description: >
16089+
The size of this custom disk partition in MB.
16090+
16091+
* The size of this disk partition must not exceed the capacity of the node's plan type.
16092+
type: integer
16093+
example: 1024
16094+
type:
16095+
description: >
16096+
This custom disk partition's filesystem type.
16097+
type: string
16098+
enum:
16099+
- raw
16100+
- ext4
16101+
example: ext-4
1603316102
LKENodePool:
1603416103
# Note that LKENodePool inherits all properties of
1603516104
# LKENodePoolRequestBody and then overrides some of the sub-properties
1603616105
type: object
1603716106
allOf:
1603816107
- $ref: '#/components/schemas/LKENodePoolRequestBody'
16108+
- type: object
1603916109
description: >
1604016110
The set of Node Pools which are members of the Kubernetes cluster.
1604116111
Node Pools consist of a Linode type, the number of Linodes to

0 commit comments

Comments
 (0)