summaryrefslogtreecommitdiff
path: root/docs/gl_objects/clusters.rst
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-12-01 01:04:53 +0100
committerGitHub <noreply@github.com>2021-12-01 01:04:53 +0100
commit8d76826fa64460e504acc5924f859f8dbc246b42 (patch)
tree083fefada982c795e2415092794db429abb0c184 /docs/gl_objects/clusters.rst
parent5a1678f43184bd459132102cc13cf8426fe0449d (diff)
parent86ab04e54ea4175f10053decfad5086cda7aa024 (diff)
downloadgitlab-master.tar.gz
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/gl_objects/clusters.rst')
-rw-r--r--docs/gl_objects/clusters.rst82
1 files changed, 0 insertions, 82 deletions
diff --git a/docs/gl_objects/clusters.rst b/docs/gl_objects/clusters.rst
deleted file mode 100644
index 96edd82..0000000
--- a/docs/gl_objects/clusters.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-############
-Clusters
-############
-
-Reference
----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectCluster`
- + :class:`gitlab.v4.objects.ProjectClusterManager`
- + :attr:`gitlab.v4.objects.Project.clusters`
- + :class:`gitlab.v4.objects.GroupCluster`
- + :class:`gitlab.v4.objects.GroupClusterManager`
- + :attr:`gitlab.v4.objects.Group.clusters`
-
-* GitLab API: https://docs.gitlab.com/ee/api/project_clusters.html
-* GitLab API: https://docs.gitlab.com/ee/api/group_clusters.html
-
-Examples
---------
-
-List clusters for a project::
-
- clusters = project.clusters.list()
-
-Create an cluster for a project::
-
- cluster = project.clusters.create(
- {
- "name": "cluster1",
- "platform_kubernetes_attributes": {
- "api_url": "http://url",
- "token": "tokenval",
- },
- })
-
-Retrieve a specific cluster for a project::
-
- cluster = project.clusters.get(cluster_id)
-
-Update an cluster for a project::
-
- cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"}
- cluster.save()
-
-Delete an cluster for a project::
-
- cluster = project.clusters.delete(cluster_id)
- # or
- cluster.delete()
-
-
-List clusters for a group::
-
- clusters = group.clusters.list()
-
-Create an cluster for a group::
-
- cluster = group.clusters.create(
- {
- "name": "cluster1",
- "platform_kubernetes_attributes": {
- "api_url": "http://url",
- "token": "tokenval",
- },
- })
-
-Retrieve a specific cluster for a group::
-
- cluster = group.clusters.get(cluster_id)
-
-Update an cluster for a group::
-
- cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"}
- cluster.save()
-
-Delete an cluster for a group::
-
- cluster = group.clusters.delete(cluster_id)
- # or
- cluster.delete()