Kollect is a tool for collecting and displaying data from Kubernetes clusters, AWS, and Azure resources. It provides a web interface to visualize various resources and allows exporting the collected data as a JSON file.
To install Kollect, clone the repository and build the binary:
git clone https://github.com/michaelcade/kollect.git
cd kollect
go build -o kollect ./cmd/kollect
Run the Kollect binary with the desired flags:
./kollect [flags]
--inventory
: Type of inventory to collect (kubernetes/aws/azure)--storage
: Collect only storage-related objects (default: false)--kubeconfig
: Path to the kubeconfig file (default: $HOME/.kube/config)--browser
: Open the web interface in a browser (default: false)--output
: Output file to save the collected data--help
: Show help messageCollect data from a Kubernetes cluster and display it in the terminal:
./kollect --inventory kubernetes
Collect data from AWS resources and display it in the terminal:
./kollect --inventory aws
Collect data from Azure resources and display it in the terminal:
./kollect --inventory azure
Collect data from a Kubernetes cluster and open the web interface:
./kollect --inventory kubernetes --browser
Collect data from AWS resources and save it to a file:
./kollect --inventory aws --output aws_data.json
.DS_Store
.github/
workflows/
release.yaml
.gitignore
api/
.DS_Store
v1/
k8sdata.go
cmd/
.DS_Store
kollect/
main.go
go.mod
go.sum
LICENSE
pkg/
.DS_Store
aws/
inventory.go
azure/
inventory.go
kollect/
kollect.go
README.md
test/
kollect_test.go
web/
.DS_Store
index.html
To build the project, run the following command:
go build -o kollect ./cmd/kollect
To run the tests, use the following command:
go test ./...
We welcome contributions to Kollect! Please open an issue or submit a pull request on GitHub.
Kollect is licensed under the MIT License. See the LICENSE file for more information.
### Summary of Changes
1. **Features**: Updated to include AWS and Azure resource collection.
2. **Usage**: Added examples for collecting data from AWS and Azure resources.
3. **Project Structure**: Included the current project structure.
4. **Development**: Added sections for building the project and running tests.
5. **Contributing**: Added a section for contributing.
6. **License**: Included a note about the license.
By following these steps, your
README.md
file should now accurately reflect the current capabilities and structure of your tool.