README
Welcome to K10s, your free and open-source Kubernetes management platform. This section introduces the basics of our platform.
Introduction
K10s is an open-source project designed to provide a comprehensive visual and hierarchical representation of Kubernetes clusters, including superclusters (clusters of clusters). This tool aims to give users an intuitive understanding of how their clusters operate, manage resources, and interconnect with underlying components.
If you find this project helpful or interesting, feel free to ⭐️ star this repository on GitHub. Your support helps us grow and reach more users in the community!
Key Features
- Visualize the full hierarchy of your Kubernetes ecosystem, from superclusters to individual pools, nodes, and pods.
- Gain real-time insights into cluster performance and management.
- Simplify complex Kubernetes structures into an understandable format for developers and administrators alike.
CONTRIBUTING
Contributing Guidelines
We appreciate your interest in contributing to our project! To ensure a smooth and efficient collaboration, please adhere to the following guidelines:
- Familiarize yourself with the project's goals, structure, and existing contributions.
- Fork the repository and create a new branch for your contributions.
- Provide clear and detailed descriptions of your changes in your pull request.
- Ensure your code is well-tested and doesn't introduce any regressions.
- Reference issue numbers in your pull request description, if applicable.
Thank you for contributing! Together, we can make K10s even better. 💜🩵🤍
CODE OF CONDUCT
Our Pledge
We aim to create an inclusive, respectful, and collaborative environment where contributors of all backgrounds feel welcome and empowered to participate.
Our Standards
- Be respectful: Treat others with kindness, empathy, and professionalism.
- Be constructive: Provide helpful feedback and foster positive discussions.
- Be inclusive: Avoid discriminatory language or behavior and embrace diversity.
Violations of this Code of Conduct will result in appropriate actions, which may include temporary or permanent removal from the community or project.
SECURITY
Reporting a Vulnerability
If you uncover any security vulnerabilities within our system, we urge you to report them promptly. Please follow these guidelines:
- Notify us immediately about the discovered vulnerability.
- Refrain from publicly disclosing the issue until we've had an opportunity to address it.
- Allow us time to investigate and provide necessary updates regarding the resolution process.
Your effort in maintaining the security of our project is invaluable. Thank you for helping us maintain a safe environment for all users and contributors.
LICENSE
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
This permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FUNDING
Why Support Us?
By funding K10s, you help us develop new features, provide timely updates, and grow our community. Every contribution makes a significant impact.
Ways to Support
- Join our Patreon to support us monthly.
- Star the repository on GitHub to help us reach more users.
- Share K10s with your colleagues, friends, and on social media.
Your support means everything to us. Thank you!