From 0410fbf6b13958087963277b4c41ae4890f0bba3 Mon Sep 17 00:00:00 2001 From: so0k Date: Tue, 12 Dec 2017 22:39:48 +0800 Subject: [PATCH] Add README on helmls --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1ca21b5..d2e25a4 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,30 @@ -# Helmns +This repository provides both `helmns` and `helmls` tools. -helmns is a [Helm](http://helm.sh) cli wrapper forcing `--tiller-namespace` to match kubectl context. +**`helmns`** `helm` cli wrapper forcing `--tiller-namespace` to match kubectl context + +**`helmls`** a small script to list Helm releases across all `--tiller-namespaces` + +# helmns + +`helmns` is a [Helm](http://helm.sh) cli wrapper forcing `--tiller-namespace` to match kubectl context. This is meant to simplify management for Kubernetes clusters with RBAC enabled and where tiller is heavily locked down per namespace. +# helmls + +`helmls` is a small script to list Helm releases across all `--tiller-namespaces`. + ----- ## Installation -Since `helmns` is written in Bash, it can run in shells that support POSIX standards. +Since `helmns` and `helmls` are written in Bash, they can run in shells that support POSIX standards. -- Download the `helmns` script +- Download the `helmns` and `helmls` scripts - Either: - - save to somewhere in your `PATH`, - - or save to a directory, then create symlinks to `helmns` from somewhere in your `PATH`, like `/usr/local/bin` -- Make `helmns` executable (`chmod +x ...`) + - save all somewhere in your `PATH`, + - or save to a directory, then create symlinks from somewhere in your `PATH`, like `/usr/local/bin` +- Make scripts executable (`chmod +x ...`) -----