From 39c8ad5a9405469370e429548e08aa475797b92b Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Sat, 9 Jun 2018 17:22:39 +0200 Subject: Add geo nodes API support Fixes #524 --- docs/gl_objects/geo_nodes.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/gl_objects/geo_nodes.rst (limited to 'docs/gl_objects') 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() -- cgit v1.2.1