readme

unwired · Jan 24, 2020 · e989900 · e989900
1 parent 1749054
commit e989900
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,31 @@
 # Kubectl with auto-completion in a docker container
 
-The purpose of this tool is to have a fully portable <code>kubectl</code> command line tool with a few convinience utilities.
-Quick testing of a cluster with well-known/customized <code>kubectl</code> setup.
+The purpose of this tool is to have a fully portable `kubectl` command line tool with a few convinience utilities.
+Quick testing of a cluster with well-known/customized `kubectl` setup.
 
 ## What is included
-- <code>kubectl</code> v 1.17.2
-- <code>kubectl</code> bash completion
-- <code>krew</code> plugin
+
+- ``kubectl`` v 1.17.2
+- ``kubectl`` bash completion
+- ``krew`` plugin
+- ``k9s`` cluster monitoring tool
 - common .bashrc aliases
 
-## How to use:
-After running docker container, all the clusters running on the localhost should be available for <code>kubectl</code> command.
+## How to use
+
+After running docker container, all the clusters running on the localhost should be available for `kubectl` command.
+
+## How the image was build
 
-## How the image was build:
 docker build --rm -f "Dockerfile" -t piotrzan/kubectl-comp "."
 
-## Convinient scripts to run the contianer:
-Use `run.ps1` or `run.sh` for windows or linux respectivels
+## Convinient scripts to run the contianer
+
+Use `run.ps1` or `run.sh` for windows or linux respectivels.
+Alternatively use docker-compose.yaml, this works by mounting a volume on the $HOME/.kube folder on the host.
 
 ### Linux Example
+
 **Run contianer with passthrough to local network**
 `docker run -d --network=host --name=kubectl-host --rm -it piotrzan/kubectl-comp`
 
@@ -30,5 +37,5 @@ docker cp ./config kubectl-host:./root/.kube`
 `docker attach kubectl-host`
 
 ## Extending the image
-If you would like to add your own customization or <code>krew</code> plugins, you can easily do it and use `docker commit` to create your own version of the image.
 
+If you would like to add your own customization or ``krew`` plugins, you can easily do it and use `docker commit` to create your own version of the image.
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -4,5 +4,6 @@ services:
     image: piotrzan/kubectl-comp
     container_name: kubectl-host
     tty: true
+    network_mode: "host"
     volumes:
      - ~/.kube/:/root/.kube/