The Kubectl Java Plugin

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

The kubectl Java plugin will make your life easier while developing Java application with k8s:

• find pods that running java application
• jvm thread dump (👨🏻‍💻 working now)
• export jvm debug port and do port-forward directly
• more future...

Built With

• cobra
• color
• uitable

Getting Started

Prerequisites

• Kubernetes Environment
  • kubectl
• Go sdk (optional)

Installation

• For developer

git clone [email protected]:Ubisoft-potato/kubectl-java.git 
cd kubectl-java
make build

then, you can find executable binary in bin dir

Usage

• find pods that running java application in your cluster

kubectl-java list

output will look like:

context:dev	namespace:dev	maserURL:https://192.168.123.123:6443
NAME                                   	NODE      	STATUS 	CONTAINERS              	JDK
user-service-64d4f59c54-w9rwr          	dev-01	        Running	[user-service]          	openjdk version "1.8.0_232"
order-service-5654856bf6-9qb26     	dev-01	        Running	[order-service]     	        openjdk version "1.8.0_232"
chat-service-58fd5b4bf-gq8wz            dev-01	        Running	[chat-service]           	openjdk version "1.8.0_232"

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Anti 996-License-1.0 License. See LICENSE for more information.

Contact

Project Link: https://github.com/Ubisoft-potato/kubectl-java

Acknowledgements

• client-go
• cli-runtime