Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Delete Kubernetes Namespace

AI-generated

Overview

This node operation deletes a Kubernetes namespace identified by a given environment identifier. It is useful in scenarios where you need to programmatically remove an entire namespace from a Kubernetes cluster, for example, when cleaning up resources after testing or decommissioning an environment.

Practical examples include:

  • Automatically deleting namespaces created for temporary development or testing environments.
  • Cleaning up namespaces as part of a CI/CD pipeline to ensure no leftover resources remain.
  • Managing Kubernetes clusters by removing unused or obsolete namespaces via automation workflows.

Properties

Name Meaning
Id Environment identifier (a numeric ID) specifying which Kubernetes namespace to delete. This is a required property.

Output

The output JSON structure is not explicitly detailed in the provided source code snippet. However, typically for a "Delete" operation on a Kubernetes namespace, the output would contain confirmation of deletion or status information about the operation's success or failure.

If the node supports binary data output, it would likely relate to raw response data from the Kubernetes API, but this is not indicated in the available code.

Dependencies

  • Requires an API key credential for authenticating with the Kubernetes cluster or the intermediary service managing Kubernetes operations.
  • The node depends on an external API endpoint configured via credentials (likely the Kubernetes API or a proxy service).
  • No additional environment variables or configurations are specified in the provided code snippet.

Troubleshooting

  • Common issues:

    • Invalid or missing environment identifier (Id): Ensure the Id property is correctly set and corresponds to an existing namespace.
    • Authentication failures: Verify that the API key or authentication token is valid and has sufficient permissions to delete namespaces.
    • Network or connectivity errors: Confirm that the node can reach the Kubernetes API endpoint.
    • Namespace not found: If the specified namespace does not exist, the operation may fail; verify the namespace exists before attempting deletion.
  • Error messages:

    • Authorization errors indicating insufficient permissions usually require updating the API credentials or roles.
    • Resource not found errors suggest the namespace ID is incorrect or the namespace was already deleted.
    • Timeout or connection errors indicate network issues or misconfigured API URLs.

Links and References

Discussion