Skip to content

Commit

Permalink
docs(k8s): add PNs in additional resources to delete (#202)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored Jun 1, 2023
1 parent aef35d9 commit b13125b
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/k8s/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ async def delete_cluster(
Delete a specific Kubernetes cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancer or Block Volume that are associated with the cluster.
:param region: Region to target. If none is passed will use default region from the config.
:param cluster_id: ID of the cluster to delete.
:param with_additional_resources: Defines whether all volumes (including retain volume type) and Load Balancers with a name starting with the cluster ID will also be deleted.
:param with_additional_resources: Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted.
:return: :class:`Cluster <Cluster>`
Usage:
Expand Down
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/k8s/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -1383,7 +1383,7 @@ class DeleteClusterRequest:

with_additional_resources: bool
"""
Defines whether all volumes (including retain volume type) and Load Balancers with a name starting with the cluster ID will also be deleted.
Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted.
"""


Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/k8s/v1/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ def delete_cluster(
Delete a specific Kubernetes cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancer or Block Volume that are associated with the cluster.
:param region: Region to target. If none is passed will use default region from the config.
:param cluster_id: ID of the cluster to delete.
:param with_additional_resources: Defines whether all volumes (including retain volume type) and Load Balancers with a name starting with the cluster ID will also be deleted.
:param with_additional_resources: Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted.
:return: :class:`Cluster <Cluster>`
Usage:
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/k8s/v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -1383,7 +1383,7 @@ class DeleteClusterRequest:

with_additional_resources: bool
"""
Defines whether all volumes (including retain volume type) and Load Balancers with a name starting with the cluster ID will also be deleted.
Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted.
"""


Expand Down

0 comments on commit b13125b

Please sign in to comment.