k8s-openapi
Reference the Kubernetes API. Useful for understanding what is possible via the Kubernetes REST API.
When & Why to Use This Skill
The k8s-openapi skill is a specialized developer tool designed to provide comprehensive reference and discovery capabilities for the Kubernetes REST API. By leveraging OpenAPI v3 endpoints, it enables users to programmatically explore available resources, understand API schemas, and identify the exact capabilities of a Kubernetes cluster, making it an essential asset for building cloud-native integrations and automation.
Use Cases
- 1. Kubernetes API Discovery: Automatically discover and map available REST endpoints and resource types within a specific cluster using the /openapi/v3 interface.
- 2. Custom Tooling Development: Assist developers in writing precise scripts, controllers, or operators by providing real-time API specifications and documentation.
- 3. DevOps Automation: Streamline infrastructure-as-code and automation workflows by identifying the correct API paths and parameters for cluster management tasks.
- 4. API Schema Validation: Verify the structure and requirements of Kubernetes objects to ensure compatibility and prevent configuration errors during deployment.
| name | k8s-openapi |
|---|---|
| description | Reference the Kubernetes API. Useful for understanding what is possible via the Kubernetes REST API. |
- Start a test cluster with:
make test-cluster-create. ONLY USE THIS SKILL ON THIS TEST CLUSTER. - Use the new context only through
--contextand--kubeconfigon eachkubectlcommand. Do not alter the config viakubectl config. - Start a proxy server with
kubectl proxy - Discover available endpoints by querying
/openapi/v3 - Use the discovered endpoints to find out what you need to
- When you have found your answer:
- Stop the proxy process; and
- Shut down the test cluster with
make test-cluster-stop