Commit d15801d
alex lundberg
docs: add project and group cluster examples
1 parent ebd053e commit d15801d
1 file changed
Lines changed: 82 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,82 @@ | |||
| 1 | + ############ | ||
| 2 | + Clusters | ||
| 3 | + ############ | ||
| 4 | + | ||
| 5 | + Reference | ||
| 6 | + --------- | ||
| 7 | + | ||
| 8 | + * v4 API: | ||
| 9 | + | ||
| 10 | + + :class:`gitlab.v4.objects.ProjectCluster` | ||
| 11 | + + :class:`gitlab.v4.objects.ProjectClusterManager` | ||
| 12 | + + :attr:`gitlab.v4.objects.Project.clusters` | ||
| 13 | + + :class:`gitlab.v4.objects.GroupCluster` | ||
| 14 | + + :class:`gitlab.v4.objects.GroupClusterManager` | ||
| 15 | + + :attr:`gitlab.v4.objects.Group.clusters` | ||
| 16 | + | ||
| 17 | + * GitLab API: https://docs.gitlab.com/ee/api/project_clusters.html | ||
| 18 | + * GitLab API: https://docs.gitlab.com/ee/api/group_clusters.html | ||
| 19 | + | ||
| 20 | + Examples | ||
| 21 | + -------- | ||
| 22 | + | ||
| 23 | + List clusters for a project:: | ||
| 24 | + | ||
| 25 | + clusters = project.clusters.list() | ||
| 26 | + | ||
| 27 | + Create an cluster for a project:: | ||
| 28 | + | ||
| 29 | + cluster = project.clusters.create( | ||
| 30 | + { | ||
| 31 | + "name": "cluster1", | ||
| 32 | + "platform_kubernetes_attributes": { | ||
| 33 | + "api_url": "http://url", | ||
| 34 | + "token": "tokenval", | ||
| 35 | + }, | ||
| 36 | + }) | ||
| 37 | + | ||
| 38 | + Retrieve a specific cluster for a project:: | ||
| 39 | + | ||
| 40 | + cluster = project.clusters.get(cluster_id) | ||
| 41 | + | ||
| 42 | + Update an cluster for a project:: | ||
| 43 | + | ||
| 44 | + cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"} | ||
| 45 | + cluster.save() | ||
| 46 | + | ||
| 47 | + Delete an cluster for a project:: | ||
| 48 | + | ||
| 49 | + cluster = project.clusters.delete(cluster_id) | ||
| 50 | + # or | ||
| 51 | + cluster.delete() | ||
| 52 | + | ||
| 53 | + | ||
| 54 | + List clusters for a group:: | ||
| 55 | + | ||
| 56 | + clusters = group.clusters.list() | ||
| 57 | + | ||
| 58 | + Create an cluster for a group:: | ||
| 59 | + | ||
| 60 | + cluster = group.clusters.create( | ||
| 61 | + { | ||
| 62 | + "name": "cluster1", | ||
| 63 | + "platform_kubernetes_attributes": { | ||
| 64 | + "api_url": "http://url", | ||
| 65 | + "token": "tokenval", | ||
| 66 | + }, | ||
| 67 | + }) | ||
| 68 | + | ||
| 69 | + Retrieve a specific cluster for a group:: | ||
| 70 | + | ||
| 71 | + cluster = group.clusters.get(cluster_id) | ||
| 72 | + | ||
| 73 | + Update an cluster for a group:: | ||
| 74 | + | ||
| 75 | + cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"} | ||
| 76 | + cluster.save() | ||
| 77 | + | ||
| 78 | + Delete an cluster for a group:: | ||
| 79 | + | ||
| 80 | + cluster = group.clusters.delete(cluster_id) | ||
| 81 | + # or | ||
| 82 | + cluster.delete() | ||
0 commit comments