Skip to content

Commit b45317f

Browse files
Merge pull request #240 from linode/lke-ga-release-prep
LKE API Hotfixes, prior to GA release
2 parents 0948f61 + 0748096 commit b45317f

File tree

1 file changed

+92
-22
lines changed

1 file changed

+92
-22
lines changed

openapi.yaml

Lines changed: 92 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6072,11 +6072,13 @@ paths:
60726072
servers:
60736073
- url: https://api.linode.com/v4beta
60746074
summary: Create Kubernetes Cluster
6075-
description: >
6075+
description: |
60766076
Creates a Kubernetes cluster. The Kubernetes cluster will be created
60776077
asynchronously. You can use the events system to determine when the
6078-
Kubernetes cluster is ready to use.
6079-
6078+
Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the
6079+
[Kubernetes API server endpoint](/api/v4/lke-clusters-cluster-id-api-endpoint) and
6080+
the [Kubeconfig file](/api/v4/lke-clusters-cluster-id-kubeconfig) for the new cluster
6081+
are ready.
60806082

60816083
**Beta**: This endpoint is in private beta. Please make sure to prepend all requests with
60826084
`/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
@@ -6091,7 +6093,7 @@ paths:
60916093
required:
60926094
- label
60936095
- region
6094-
- version
6096+
- k8s_version
60956097
- node_pools
60966098
allOf:
60976099
- $ref: '#/components/schemas/LKEClusterRequestBody'
@@ -6117,7 +6119,7 @@ paths:
61176119
-X POST -d '{
61186120
"label": "cluster12345",
61196121
"region": "us-central",
6120-
"version": "1.16",
6122+
"k8s_version": "1.16",
61216123
"tags": ["ecomm", "blogs"],
61226124
"node_pools": [
61236125
{ "type": "g6-standard-4", "count": 6},
@@ -6130,7 +6132,7 @@ paths:
61306132
linode-cli lke cluster-create \
61316133
--label cluster12345 \
61326134
--region us-central \
6133-
--version 1.16 \
6135+
--k8s_version 1.16 \
61346136
--node_pools.type g6-standard-4 --node_pools.count 6 \
61356137
--node_pools.type g6-standard-8 --node_pools.count 3 \
61366138
--tags ecomm
@@ -6248,8 +6250,8 @@ paths:
62486250
$ref: '#/components/schemas/LKECluster/properties/updated'
62496251
region:
62506252
$ref: '#/components/schemas/LKECluster/properties/region'
6251-
version:
6252-
$ref: '#/components/schemas/LKECluster/properties/version'
6253+
k8s_version:
6254+
$ref: '#/components/schemas/LKECluster/properties/k8s_version'
62536255
x-code-samples:
62546256
- lang: Shell
62556257
source: >
@@ -6585,6 +6587,73 @@ paths:
65856587
- lang: CLI
65866588
source: >
65876589
linode-cli lke pool-delete 12345 456
6590+
/lke/clusters/{clusterId}/api-endpoints:
6591+
parameters:
6592+
- name: clusterId
6593+
in: path
6594+
description: ID of the Kubernetes cluster to look up.
6595+
required: true
6596+
schema:
6597+
type: integer
6598+
x-linode-cli-command: lke
6599+
get:
6600+
operationId: getLKEClusterAPIEndpoints
6601+
x-linode-cli-action: api-endpoints-list
6602+
security:
6603+
- personalAccessToken: []
6604+
- oauth:
6605+
- lke:read_only
6606+
tags:
6607+
- Linode Kubernetes Engine (LKE)
6608+
servers:
6609+
- url: https://api.linode.com/v4beta
6610+
summary: List Kubernetes API Endpoints
6611+
description: >
6612+
List the Kubernetes API server endpoints for this cluster. Please note that it often takes
6613+
2-5 minutes before the endpoint is ready after first [creating a new cluster](/api/v4/lke-clusters/#post).
6614+
6615+
6616+
**Beta**: This endpoint is in private beta. Please make sure to prepend all requests with
6617+
`/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
6618+
updates in the future. This notice will be removed when this endpoint is out of
6619+
beta. Sign up for the beta [here](https://welcome.linode.com/lkebeta/).
6620+
responses:
6621+
'200':
6622+
description: Returns the Kubernetes API server endpoints for this cluster.
6623+
content:
6624+
application/json:
6625+
schema:
6626+
type: object
6627+
properties:
6628+
data:
6629+
type: array
6630+
items:
6631+
type: object
6632+
description: >
6633+
The Kubernetes API server endpoints for this cluster.
6634+
properties:
6635+
endpoint:
6636+
type: string
6637+
readOnly: true
6638+
description: >
6639+
A Kubernetes API server endpoint for this cluster.
6640+
example: "https://192.0.2.1:6443"
6641+
page:
6642+
$ref: '#/components/schemas/PaginationEnvelope/properties/page'
6643+
pages:
6644+
$ref: '#/components/schemas/PaginationEnvelope/properties/pages'
6645+
results:
6646+
$ref: '#/components/schemas/PaginationEnvelope/properties/results'
6647+
default:
6648+
$ref: '#/components/responses/ErrorResponse'
6649+
x-code-samples:
6650+
- lang: Shell
6651+
source: >
6652+
curl -H "Authorization: Bearer $TOKEN" \
6653+
https://api.linode.com/v4beta/lke/clusters/12345/api-endpoints
6654+
- lang: CLI
6655+
source: >
6656+
linode-cli lke api-endpoint-list 12345
65886657
/lke/clusters/{clusterId}/api-endpoint:
65896658
parameters:
65906659
- name: clusterId
@@ -6606,8 +6675,13 @@ paths:
66066675
servers:
66076676
- url: https://api.linode.com/v4beta
66086677
summary: View Kubernetes API Endpoint
6609-
description: >
6610-
Get the Kubernetes API server endpoint for this cluster.
6678+
description: |
6679+
Get the Kubernetes API server endpoint for this cluster. Please note that it often takes
6680+
2-5 minutes before the endpoint is ready after first
6681+
[creating a new cluster](/api/v4/lke-clusters/#post).
6682+
6683+
**Note** This endpoint will be deprecated in favor of
6684+
[List Kubernetes API Endpoints](/api/v4/lke-clusters-cluster-id-api-endpoints).
66116685

66126686

66136687
**Beta**: This endpoint is in private beta. Please make sure to prepend all requests with
@@ -6659,9 +6733,9 @@ paths:
66596733
servers:
66606734
- url: https://api.linode.com/v4beta
66616735
summary: View Kubeconfig
6662-
description: >
6663-
Get the Kubeconfig file for a Cluster.
6664-
6736+
description: |
6737+
Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before
6738+
the Kubeconfig file is ready after first [creating a new cluster](/api/v4/lke-clusters/#post).
66656739

66666740
**Beta**: This endpoint is in private beta. Please make sure to prepend all requests with
66676741
`/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
@@ -15700,7 +15774,7 @@ components:
1570015774
type: string
1570115775
description: This Kubernetes cluster's location.
1570215776
example: us-central
15703-
version:
15777+
k8s_version:
1570415778
type: string
1570515779
description: >
1570615780
The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>,
@@ -15718,7 +15792,7 @@ components:
1571815792
required:
1571915793
- label
1572015794
- region
15721-
- version
15795+
- k8s_version
1572215796
LKECluster:
1572315797
type: object
1572415798
# Note that LKECluster inherits all properties of
@@ -15748,16 +15822,13 @@ components:
1574815822
# LKEClusterRequestBody but otherwise inherit all of the original
1574915823
# sub-properties.
1575015824
label:
15751-
x-linode-filterable: true
1575215825
x-linode-cli-display: 2
1575315826
example: lkecluster12345
1575415827
region:
1575515828
readOnly: true
15756-
x-linode-filterable: true
1575715829
x-linode-cli-display: 3
1575815830
example: us-central
15759-
version:
15760-
x-linode-filterable: true
15831+
k8s_version:
1576115832
example: "1.16"
1576215833
tags:
1576315834
example:
@@ -15812,11 +15883,10 @@ components:
1581215883
readOnly: true
1581315884
properties:
1581415885
id:
15815-
type: number
15886+
type: string
1581615887
description: >
1581715888
The Node's ID.
15818-
x-linode-filterable: true
15819-
example: 123456
15889+
example: "123456"
1582015890
instance_id:
1582115891
type: string
1582215892
description: >

0 commit comments

Comments
 (0)