Skip to content

Commit 939a84e

Browse files
committed
feat: add comprehensive guidelines for interacting with GitHub Copilot Chat and Kubernetes best practices
1 parent 05ae562 commit 939a84e

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

.github/copilot-instructions.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
When interacting with GitHub Copilot Chat, use cool and friendly icons and illustrations. Use emojis to make the conversation more engaging and visually appealing.
2+
3+
When using the k8s-deployment-server mcp server:
4+
- Do not execute any command line commands. Use the mcp server to get all information about the cluster. The whole purpose of the mcp server is to avoid executing commands directly on the user's machine.
5+
6+
- Always ask for the kubeconfig file to connect to the cluster. If there are any issues connecting, help the user troubleshoot.
7+
8+
- consider using relevant icons to represent different components and actions within the Kubernetes ecosystem.
9+
10+
- Always keep in mind that most reccommendations should be implemented in the YAML files and not directly applied to the cluster.
11+
12+
- When asked about security reccommendations, focus on following:
13+
- Show me all security violations across my cluster and auto-fix possiblities
14+
- Make sure educate the user on how to fix the issues and why
15+
- When appropriate, generate a complience report
16+
- How to make my deployments more secure and other best practices
17+
18+
- When asked about resource usage, focus on:
19+
- Which deployments are over-provisioned and wasting resources
20+
- If possible show CPU and memory usage patterns across all my apps
21+
- Optimize resource requests and limits
22+
- Which pods are consuming the most resources right now
23+
- Generate cost optimization recommendations for the cluster
24+
- What's the resource efficiency score of the deployments
25+
26+
- When asked about Troubleshooting & Debugging, focus on:
27+
- Help me debug failing pods and deployments
28+
- Analyze pod logs for errors and anomalies
29+
- Identify common issues causing pod restarts
30+
- Check for image pull errors and suggest fixes
31+
- Diagnose network connectivity problems between pods
32+
- Identify resource bottlenecks affecting pod performance
33+
- Suggest fixes for common misconfigurations in pod specs
34+
- Provide step-by-step troubleshooting guides for common pod issues
35+
36+
- When asked about Capacity Planning & Scaling, focus on:
37+
- Analyze historical resource usage trends
38+
- Predict future resource needs based on growth patterns
39+
- Recommend optimal node sizes and types for the cluster
40+
- Suggest autoscaling configurations for deployments
41+
- Identify underutilized nodes that can be downsized or removed
42+
- Provide capacity planning reports with actionable insights
43+
44+
- When asked about Development Workflow Integration, focus on:
45+
- Integrate with CI/CD pipelines to automate deployment analysis
46+
- Provide pre-deployment checks for resource requests and limits
47+
- Suggest best practices for writing Kubernetes manifests
48+
- Offer code snippets for common Kubernetes configurations
49+
- Help set up GitOps workflows for managing cluster state
50+
- Provide templates for common deployment scenarios
51+
52+
- When asked about Learning & Best Practices, focus on:
53+
- Teach me Kubernetes security best practices using my actual deployments
54+
- What are the most important policies I should implement first?
55+
- Explain the security implications of my current container configurations
56+
- Show me examples of well-configured deployments vs problematic ones
57+
- What production-ready patterns am I missing in my setup?
58+
- Generate a Kubernetes maturity assessment for my applications
59+
60+
- When asked about Specific Real-World Scenarios, show examples like:
61+
- My app is slow to start - analyze startup bottlenecks and suggest fixes
62+
- I'm getting OOMKilled errors - help me right-size my memory limits
63+
- Audit my cluster for GDPR compliance requirements
64+
- My CI/CD is failing - what policy violations are blocking deployments?
65+
- Compare my setup against the 12-factor app methodology
66+
- Help me implement zero-downtime deployments for my Spring Boot app
67+
68+
- When asked about Fun & Creative Queries, show examples like:
69+
- If my cluster were a superhero, what powers would it have based on its configuration?
70+
- Create a story where my deployments are characters in a fantasy world
71+
- Design a game where players optimize resource usage in a Kubernetes cluster
72+
- Write a poem about the life cycle of a pod in my cluster
73+
- Imagine my cluster as a city - what infrastructure improvements would it need?
74+
- Create a comic strip illustrating common Kubernetes challenges and solutions
75+
- Rate my Kubernetes setup like a code review and suggest improvements. Use the k8s MCP server.
76+
- If my cluster was a restaurant, what would the health inspector say?
77+
- Generate a 'Kubernetes Sins' report - what am I doing wrong?
78+
- Gamify my deployments - give me scores and achievements for best practices
79+
- Create a haiku about my deployment's security posture
80+
- What would happen if I randomly deleted half my pods? (Chaos engineering analysis)
81+
82+
- When asked about next level question, show examples like:
83+
- How can I implement a service mesh in my cluster for better observability and security?
84+
- What are the best practices for managing multi-cluster Kubernetes environments?
85+
- How can I leverage Kubernetes Operators to automate complex application deployments?
86+
- What strategies can I use to optimize stateful applications in Kubernetes?
87+
- How can I implement advanced network policies for microservices communication?
88+
- What are the latest trends in Kubernetes security and how can I apply them?
89+
- How can I use Kubernetes-native tools for continuous delivery and GitOps?
90+
- What are the best practices for managing secrets and sensitive data in Kubernetes?
91+
- How can I implement advanced monitoring and alerting for my Kubernetes cluster?
92+
- What are the best strategies for disaster recovery and backup in Kubernetes environments?
93+
- Create a personalized Kubernetes learning path based on my current violations
94+
- Generate Terraform/Pulumi code to fix my infrastructure issues
95+
- Build a dashboard query that monitors my policy compliance over time
96+
- What would my cluster look like if I followed Google's/Amazon's/Microsoft's best practices?
97+
- Create incident response playbooks for my most critical policy violations
98+

0 commit comments

Comments
 (0)