Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Get All Kubernetes Config Maps

AI-generated

Overview

This node operation retrieves all Kubernetes Config Maps from a specified environment. It is useful for users who want to list and inspect Config Maps within their Kubernetes clusters, which are key-value stores used to hold configuration data for applications. A practical example includes auditing or managing configuration settings across multiple environments or applications by fetching all Config Maps and optionally including information about which applications use them.

Properties

Name Meaning
Id Environment identifier (a numeric ID) specifying which Kubernetes environment to query.
Is Used Boolean flag indicating whether to include information about applications that use the Config Maps in the response. Options: true or false.

Output

The output JSON contains an array of Kubernetes Config Maps retrieved from the specified environment. Each Config Map object typically includes metadata such as name, namespace, labels, and the actual configuration data stored as key-value pairs. If the "Is Used" property is set to true, additional information about the applications using each Config Map will be included.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to a Kubernetes environment identified by the provided environment ID.
  • Requires an API key credential or authentication token configured in n8n to authorize requests to the Kubernetes API or intermediary service managing Kubernetes resources.
  • The node depends on an external API endpoint (likely Portainer or similar Kubernetes management API) to fetch Config Maps.

Troubleshooting

  • Common issues:

    • Invalid or missing environment ID may cause failure to retrieve Config Maps.
    • Insufficient permissions or invalid API credentials can result in authorization errors.
    • Network connectivity issues to the Kubernetes API or management service can cause timeouts or connection errors.
  • Error messages:

    • Authorization errors: Check that the API key or authentication token is correctly configured and has sufficient permissions.
    • Not found or empty results: Verify that the environment ID corresponds to an existing Kubernetes cluster and that Config Maps exist.
    • Timeout or network errors: Ensure network access to the Kubernetes API endpoint is available.

Links and References

Discussion