Skip to content

Commit 0d58bc0

Browse files
Added documentation for image.py, lke,py, and longview.py. (#265)
## 📝 Description Added documentation for `objects/image.py`, `objects/lke,py`, and `objects/longview.py`. ## ✔️ How to Test `pytest test` Tickets: TPT-1925, TPT-1927, TPT-1928 Co-authored-by: Zhiwei Liang <121905282+zliang-akamai@users.noreply.github.com>
1 parent 8b56a58 commit 0d58bc0

File tree

3 files changed

+66
-1
lines changed

3 files changed

+66
-1
lines changed

linode_api4/objects/image.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
class Image(Base):
55
"""
66
An Image is something a Linode Instance or Disk can be deployed from.
7+
8+
API Documentation: https://www.linode.com/docs/api/images/#image-view
79
"""
810

911
api_endpoint = "/images/{id}"

linode_api4/objects/lke.py

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
class KubeVersion(Base):
1414
"""
1515
A KubeVersion is a version of Kubernetes that can be deployed on LKE.
16+
17+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubernetes-version-view
1618
"""
1719

1820
api_endpoint = "/lke/versions/{id}"
@@ -52,6 +54,8 @@ class LKENodePool(DerivedBase):
5254
"""
5355
An LKE Node Pool describes a pool of Linode Instances that exist within an
5456
LKE Cluster.
57+
58+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#node-pool-view
5559
"""
5660

5761
api_endpoint = "/lke/clusters/{cluster_id}/pools/{id}"
@@ -88,6 +92,8 @@ def recycle(self):
8892
Deleted and recreates all Linodes in this Node Pool in a rolling fashion.
8993
Completing this operation may take several minutes. This operation will
9094
cause all local data on Linode Instances in this pool to be lost.
95+
96+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#node-pool-recycle
9197
"""
9298
self._client.post(
9399
"{}/recycle".format(LKENodePool.api_endpoint), model=self
@@ -98,6 +104,8 @@ def recycle(self):
98104
class LKECluster(Base):
99105
"""
100106
An LKE Cluster is a single k8s cluster deployed via Linode Kubernetes Engine.
107+
108+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-view
101109
"""
102110

103111
api_endpoint = "/lke/clusters/{id}"
@@ -118,6 +126,11 @@ class LKECluster(Base):
118126
def api_endpoints(self):
119127
"""
120128
A list of API Endpoints for this Cluster.
129+
130+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubernetes-api-endpoints-list
131+
132+
:returns: A list of MappedObjects of the API Endpoints
133+
:rtype: List[MappedObject]
121134
"""
122135
# This result appears to be a PaginatedList, but objects in the list don't
123136
# have IDs and can't be retrieved on their own, and it doesn't accept normal
@@ -151,6 +164,11 @@ def kubeconfig(self):
151164
152165
It may take a few minutes for a config to be ready when creating a new
153166
cluster; during that time this request may fail.
167+
168+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubeconfig-view
169+
170+
:returns: The Kubeconfig file for this Cluster.
171+
:rtype: str
154172
"""
155173
if not hasattr(self, "_kubeconfig"):
156174
result = self._client.get(
@@ -165,6 +183,8 @@ def node_pool_create(self, node_type, node_count, **kwargs):
165183
"""
166184
Creates a new :any:`LKENodePool` for this cluster.
167185
186+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#node-pool-create
187+
168188
:param node_type: The type of nodes to create in this pool.
169189
:type node_type: :any:`Type` or str
170190
:param node_count: The number of nodes to create in this pool.
@@ -196,6 +216,11 @@ def node_pool_create(self, node_type, node_count, **kwargs):
196216
def cluster_dashboard_url_view(self):
197217
"""
198218
Get a Kubernetes Dashboard access URL for this Cluster.
219+
220+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-dashboard-url-view
221+
222+
:returns: The Kubernetes Dashboard access URL for this Cluster.
223+
:rtype: str
199224
"""
200225

201226
result = self._client.get(
@@ -207,6 +232,8 @@ def cluster_dashboard_url_view(self):
207232
def kubeconfig_delete(self):
208233
"""
209234
Delete and regenerate the Kubeconfig file for a Cluster.
235+
236+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubeconfig-delete
210237
"""
211238

212239
self._client.delete(
@@ -215,7 +242,15 @@ def kubeconfig_delete(self):
215242

216243
def node_view(self, nodeId):
217244
"""
218-
Get a specific Node Pool by ID.
245+
Get a specific Node by ID.
246+
247+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#node-view
248+
249+
:param nodeId: ID of the Node to look up.
250+
:type nodeId: str
251+
252+
:returns: The specified Node
253+
:rtype: LKENodePoolNode
219254
"""
220255

221256
node = self._client.get(
@@ -227,6 +262,11 @@ def node_view(self, nodeId):
227262
def node_delete(self, nodeId):
228263
"""
229264
Delete a specific Node from a Node Pool.
265+
266+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#node-delete
267+
268+
:param nodeId: ID of the Node to delete.
269+
:type nodeId: str
230270
"""
231271

232272
self._client.delete(
@@ -236,6 +276,11 @@ def node_delete(self, nodeId):
236276
def node_recycle(self, nodeId):
237277
"""
238278
Recycle a specific Node from an LKE cluster.
279+
280+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#node-recycle
281+
282+
:param nodeId: ID of the Node to recycle.
283+
:type nodeId: str
239284
"""
240285

241286
self._client.post(
@@ -246,6 +291,8 @@ def node_recycle(self, nodeId):
246291
def cluster_nodes_recycle(self):
247292
"""
248293
Recycles all nodes in all pools of a designated Kubernetes Cluster.
294+
295+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#cluster-nodes-recycle
249296
"""
250297

251298
self._client.post(
@@ -255,6 +302,8 @@ def cluster_nodes_recycle(self):
255302
def cluster_regenerate(self):
256303
"""
257304
Regenerate the Kubeconfig file and/or the service account token for a Cluster.
305+
306+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-regenerate
258307
"""
259308

260309
self._client.post(
@@ -264,6 +313,8 @@ def cluster_regenerate(self):
264313
def service_token_delete(self):
265314
"""
266315
Delete and regenerate the service account token for a Cluster.
316+
317+
API Documentation: https://www.linode.com/docs/api/linode-kubernetes-engine-lke/#service-token-delete
267318
"""
268319

269320
self._client.delete(

linode_api4/objects/longview.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33

44
class LongviewClient(Base):
5+
"""
6+
A Longview Client that is accessible for use. Longview is Linode’s system data graphing service.
7+
8+
API Documentation: https://www.linode.com/docs/api/longview/#longview-client-view
9+
"""
10+
511
api_endpoint = "/longview/clients/{id}"
612

713
properties = {
@@ -16,6 +22,12 @@ class LongviewClient(Base):
1622

1723

1824
class LongviewSubscription(Base):
25+
"""
26+
Contains the Longview Plan details for a specific subscription id.
27+
28+
API Documentation: https://www.linode.com/docs/api/longview/#longview-subscription-view
29+
"""
30+
1931
api_endpoint = "/longview/subscriptions/{id}"
2032

2133
properties = {

0 commit comments

Comments
 (0)