GitLab API

GitlabTool

Actions1000

Overview

This node operation updates a specific cluster within a GitLab project using the GitLab API. It is useful for managing and modifying cluster configurations associated with a project, such as updating cluster details or settings. For example, a DevOps engineer might use this node to update the cluster information for a project to reflect changes in infrastructure or deployment environments.

Use Case Examples

  1. Updating cluster details for a project in GitLab to change its configuration or metadata.
  2. Modifying cluster settings to enable or disable certain features or integrations within a GitLab project.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to PUT for this operation.
Path Parameters Parameters for the API path, including the project ID or URL-encoded path and the cluster ID to identify the cluster to update.

Output

JSON

  • id - The unique identifier of the updated cluster.
  • name - The name of the cluster.
  • environment_scope - The environment scope associated with the cluster.
  • platform_kubernetes_attributes
    • api_url - The API URL of the Kubernetes platform for the cluster.
    • token - The token used for authenticating with the Kubernetes platform.
  • created_at - Timestamp when the cluster was created.
  • updated_at - Timestamp when the cluster was last updated.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and cluster ID are correctly specified and URL-encoded if necessary.
  • Verify that the authentication credentials are valid and have sufficient permissions to update clusters in the project.
  • Check that the request body schema matches the expected structure for updating a cluster as per GitLab API documentation.
  • Common error messages may include 401 Unauthorized (authentication issues), 404 Not Found (invalid project or cluster ID), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, IDs, or request payload.

Links

Discussion