Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Update Kubernetes Service

AI-generated

Overview

This node operation updates an existing Kubernetes Service within a specified namespace. It is useful for modifying the configuration or metadata of a Kubernetes Service resource, such as changing labels, selectors, ports, or other service specifications without deleting and recreating the service.

Common scenarios include:

  • Updating the port configuration of a service to expose different application ports.
  • Changing the selector labels to redirect traffic to a different set of pods.
  • Modifying annotations or metadata for integration with other tools or monitoring systems.

Example: You have a Kubernetes Service exposing your web application on port 80, but you want to update it to expose port 8080 instead. This node operation allows you to send the updated service definition to apply that change seamlessly.

Properties

Name Meaning
Id Environment identifier (a numeric ID representing the target Kubernetes environment).
Namespace The Kubernetes namespace where the service exists and will be updated.
Body The full JSON string defining the updated Kubernetes Service specification.

Output

The node outputs the JSON response from the Kubernetes API after attempting to update the service. This typically includes the updated service object reflecting the changes applied.

If the node supports binary data output, it would generally relate to raw HTTP response content, but based on the provided code and properties, the output is JSON only.

Dependencies

  • Requires access to a Kubernetes cluster API endpoint.
  • Needs proper authentication credentials configured in n8n to authorize API requests against the Kubernetes cluster.
  • The user must provide a valid service definition JSON body matching Kubernetes Service schema.

Troubleshooting

  • Invalid Service Definition: If the JSON body is malformed or does not conform to Kubernetes Service schema, the API will reject the update. Validate the JSON before sending.
  • Namespace Not Found: Specifying a non-existent namespace will cause errors. Ensure the namespace exists in the cluster.
  • Service Not Found: The service identified by the given parameters must exist; otherwise, the update will fail.
  • Authentication Errors: Missing or incorrect API credentials will prevent communication with the Kubernetes API.
  • API Version Mismatch: Using outdated or incompatible Kubernetes API versions in the service definition may cause errors.

Links and References

Discussion