Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Get Kubernetes Namespace

AI-generated

Overview

This node operation retrieves detailed information about a specific Kubernetes namespace. It is useful for scenarios where you need to inspect or manage namespaces within a Kubernetes cluster, such as verifying namespace existence, checking configuration details, or auditing resource quotas associated with that namespace.

Practical examples include:

  • Fetching namespace details before deploying applications to ensure the target namespace exists.
  • Retrieving resource quota information to monitor and enforce resource usage limits within a namespace.
  • Integrating namespace data into workflows that automate Kubernetes cluster management or reporting.

Properties

Name Meaning
Id Environment identifier (a numeric ID representing the Kubernetes environment or cluster).
Namespace The name of the Kubernetes namespace to retrieve details for.
With Resource Quota Boolean flag indicating whether to include resource quota information as part of the namespace details.

Output

The output JSON contains detailed information about the specified Kubernetes namespace. This includes metadata such as the namespace name, status, labels, annotations, and optionally, resource quota details if requested.

If the "With Resource Quota" property is set to true, the output will also include resource quota information related to the namespace, providing insights into resource limits and usage constraints.

No binary data output is expected from this operation.

Dependencies

  • Requires access to a Kubernetes cluster API endpoint.
  • Needs an API key or authentication token configured in n8n credentials to authenticate requests to the Kubernetes API.
  • Proper network connectivity and permissions to query namespace information on the Kubernetes cluster.

Troubleshooting

  • Common issues:

    • Invalid or missing environment identifier may cause failure to connect to the correct Kubernetes cluster.
    • Incorrect namespace name will result in errors or empty responses.
    • Insufficient permissions or authentication failures can prevent retrieval of namespace details.
    • Network connectivity issues between n8n and the Kubernetes API server.

  • Error messages and resolutions:

    • "Namespace not found": Verify the namespace name is correct and exists in the cluster.
    • "Unauthorized" or "Forbidden": Check API credentials and permissions assigned to the token or user.
    • Timeout or connection errors: Ensure network access to the Kubernetes API endpoint and that the cluster is reachable.

Links and References

Discussion