README.md

IKS Context Cleaner

A little utility to make your IKS work a bit better Report Bug · Request Feature

Table of Contents

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

About The Project

This project could help you to cleanup the default IKS/OpenShift kubernets kube config files to use them in combination with othe toolchain, like kubectx, kubie, etc

By default the IBMCloud CLI tool (kubernetes service plugin) gathers the configuration (kubeconfig) to access to your cluster using the human readable cluster's name + the cluster ID, which is completely useless for humans and makes very hard to work with other tools, so this small utility clean all this stuff and will allow you to use directly the name of the cluster, for example using kubie:

kubie ctx the_human_readable_name_of_my_k8s_cluster -n kube-system

in just one shot

Built With

• golang

Getting Started

To get a local copy up and running follow these simple example steps.

make build && cat tests/data/kubeconfig_sample.yaml | ./bin/ikscc

Prerequisites

You don't need extra requisite to use this program, just get the release for your OS and execute it

Installation

Just download a copy of the releases for your OS

Usage

ibmcloud ks cluster config --cluster my_iks_cluster -q --output yaml | ikscc > ${HOME}/.kube/config

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 MIT License. See LICENSE for more information.

Contact

Javier Juarez - @thejtoken - [email protected]

Project Link: https://github.com/jjuarez/iks-ctx-cleaner