diff --git a/README.md b/README.md index eeb2559abc4d8811679a4098ba4eb0ce76480807..42f751a771eb218fbfec277be28def8516eadf16 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# OpenAppStack bootstrap script +# OpenAppStack -The OpenAppStack bootstrap script allows you to easily set up a new OpenAppStack -cluster. +OpenAppStack allows you to easily set up a new OpenAppStack instance, based on +a single-node kubernetes cluster. > **WARNING: The installation process will make substantial changes to the -> server’s configuration, so please ONLY install OAS in a testing environment.** +> server’s configuration, so please ONLY install OAS on a dedicated, clean +> server.** Please refer to https://docs.openappstack.net for further details, and to [the installation tutorial](docs/installation_instructions.md) for a step -by step installation tutorial how to bootstrap your cluster. +by step installation tutorial how to install your cluster. diff --git a/helmfiles/README.md b/helmfiles/README.md index 00d358802d4d8286b28b267daf8ba802ec7b956f..7124e7edae0d1fac6f401d8a443e3ebd34e7071d 100644 --- a/helmfiles/README.md +++ b/helmfiles/README.md @@ -14,8 +14,8 @@ The data in this directory is typically used by the Ansible playbooks located in the `ansible/` top level directory. Check the tasks tagged `helmfile` to get more information. -If you have a cluster already, and do not want to use our bootstrap script to -install these applications, follow these steps: +If you have a cluster already, and do not want to use our OpenAppStack +installation script to install these applications, follow these steps: ### Prerequisites diff --git a/test/README.md b/test/README.md index a94a8ebcca98e2eea1622ae6f0c2b900af122769..6f7a9be65f53c166ca6f751578dfb94badc5f291 100644 --- a/test/README.md +++ b/test/README.md @@ -48,9 +48,9 @@ or directly (allows better debugging since pytest won't eat stdout): ## Run *behave* tests The behave tests are controlled by the `openappstack` CLI command suite. To run -the behave tests, run the following command in this repository: +the behave tests, run the following command in this repository: - python -m openappstack CLUSTERNAME test + python -m openappstack CLUSTERNAME test In the future, this command will run all tests, but now only *behave* is implemented. To learn more about the `test` subcommand, run: @@ -64,7 +64,7 @@ implemented. To learn more about the `test` subcommand, run: not verified. Therefore we need to force plain ssh:// with either `connection=ssh` or `--hosts=ssh://…` -# Running bootstrap CI with local gitlab-runner docker executor +# Running CI with local gitlab-runner docker executor Export the following environment variables like this: