diff --git a/README.md b/README.md index db5dadb4a1aab8c64c35aaa02b9223458fb4b971..ff6ea87f26fa3ec421b6ad87de6b86f55ce85903 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ a Docker image) which contains utilities to manage your cluster. * You need to have ssh access (either as root, or as another user that can `sudo`) to the machines that will make up your cluster. * You need `ansible >= 2.5` installed on your workstation to run the bootstrap - scripts. Install the requirements like this: + scripts. Please install it using your system package manager. + In the case your system package manager doesn't provide `ansible >= 2.5` you + can install it via the python package manager like this: `pip3 install --user -r ansible/requirements.txt` @@ -37,9 +39,15 @@ ansible-playbook bootstrap.yml ## Managing an existing cluster -The OpenAppStack project has created a special "control shell", a Docker -container that you can run to perform administrative tasks on your cluster. -Some programs that you can run from this shell: +Login to your cluster with: + + ssh USER@SERVER + +where `SERVER` is the address of the master machine of your cluster and +`USER` the `ansible_user` you configured in `ansible/inventory.yml`. + +Some programs that are installed on your cluster: + * `kubectl` is the Kubernetes control program. For example, run `kubectl get pod` to see a list of pods that currently exist in your cluster. Run `kubectl --help` for help. @@ -50,11 +58,3 @@ Some programs that you can run from this shell: run `helmfile -e oas diff` to view the differences between what's currently installed and what should be installed according to the OpenAppStack installation plan. - -To start the control shell, run - -``` -./manage $SERVER -``` - -where `$SERVER` is the address of the master machine of your cluster. diff --git a/manage b/manage deleted file mode 100755 index f033c237421ba013ad9b04cbe6ec1c693d1bfc82..0000000000000000000000000000000000000000 --- a/manage +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash - -if [ -z "$1" ] -then - echo "Usage: ./manage SERVER-IP" - exit 1 -else - host=$1 -fi - -ssh -t "root@${host}" bash -ic "oas_controlshell"