Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Create Kubernetes Service

AI-generated

Overview

This node operation allows users to create a Kubernetes Service within a specified Kubernetes cluster environment. It is useful for automating the deployment and management of services in Kubernetes, enabling seamless integration with Kubernetes APIs directly from n8n workflows. Typical use cases include setting up new services for applications, exposing pods internally or externally, and managing service lifecycles programmatically.

For example, you might use this node to create a LoadBalancer service that exposes your application to external traffic or a ClusterIP service for internal communication between pods.

Properties

Name Meaning
Id Environment identifier: a numeric ID representing the target Kubernetes environment.
Namespace Namespace name: the Kubernetes namespace where the service will be created.
Body Service definition: a JSON string defining the Kubernetes Service resource specification.
  • The Body property expects a full Kubernetes Service manifest in JSON format, specifying metadata, spec, ports, selectors, and other relevant fields according to Kubernetes API conventions.

Output

The node outputs the response from the Kubernetes API after attempting to create the service. This output is provided in the json field and typically contains the details of the created Service resource, including its metadata, status, and spec as returned by the Kubernetes API server.

If the creation is successful, the output JSON reflects the newly created service object. If there is an error (e.g., invalid body, namespace not found), the output will contain error information accordingly.

No binary data output is involved in this operation.

Dependencies

  • Requires access to a Kubernetes cluster API endpoint.
  • Needs an API key or token credential configured in n8n to authenticate requests against the Kubernetes API.
  • The node uses HTTP requests to interact with the Kubernetes REST API; thus, network connectivity and proper permissions are necessary.

Troubleshooting

  • Invalid Service Definition: If the JSON in the Body property is malformed or does not conform to Kubernetes Service schema, the API will reject the request. Validate the JSON structure before sending.
  • Namespace Not Found: Specifying a non-existent namespace will cause the API to return an error. Ensure the namespace exists in the cluster.
  • Authentication Errors: Missing or incorrect API credentials will result in authorization failures. Verify that the API token or key has sufficient permissions.
  • Network Issues: Connectivity problems to the Kubernetes API endpoint can cause timeouts or connection errors. Check network settings and endpoint accessibility.

Common error messages usually come directly from the Kubernetes API and should be interpreted based on standard Kubernetes API error codes and messages.

Links and References

Discussion