summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/geo_nodes.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/gl_objects/geo_nodes.rst b/docs/gl_objects/geo_nodes.rst
new file mode 100644
index 0000000..44ed391
--- /dev/null
+++ b/docs/gl_objects/geo_nodes.rst
@@ -0,0 +1,43 @@
+#########
+Geo nodes
+#########
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GeoNode`
+ + :class:`gitlab.v4.objects.GeoNodeManager`
+ + :attr:`gitlab.Gitlab.geonodes`
+
+* GitLab API: https://docs.gitlab.com/ee/api/geo_nodes.html
+
+Examples
+--------
+
+List the geo nodes::
+
+ nodes = gl.geonodes.list()
+
+Get the status of all the nodes::
+
+ status = gl.geonodes.status()
+
+Get a specific node and its status::
+
+ node = gl.geonodes.get(node_id)
+ node.status()
+
+Edit a node configuration::
+
+ node.url = 'https://secondary.mygitlab.domain'
+ node.save()
+
+Delete a node::
+
+ node.delete()
+
+List the sync failure on the current node::
+
+ failures = gl.geonodes.current_failures()