From 7627d666ea69d9fe1d96d709dae37406d606da36 Mon Sep 17 00:00:00 2001 From: MoeweX Date: Mon, 8 Jun 2020 17:22:48 +0200 Subject: [PATCH] Fix typos --- README.md | 2 ++ node-manager/playbooks/{Playbooks.md => README.md} | 10 +++++----- 2 files changed, 7 insertions(+), 5 deletions(-) rename node-manager/playbooks/{Playbooks.md => README.md} (93%) diff --git a/README.md b/README.md index 1f65e52..c999637 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,8 @@ For this purpose, it offers a REST interface; this interface is fully documented - Copy and customize the infrastructure.jsonc file from the `node-manager/run-examples/config` directory to the `node-manager/run/config` directory - You can now use MockFog2, change directory to `node-manager` and bootstrap your infrastructure by running `node app.js bootstrap` +If you do not want to use Gitpod, run the tasks from the [.gitpod.yml](./.gitpod.yml) file manually before doing the above. + ## Roadmap For more information on the roadmap and related issues, see the [project overview](https://github.com/MoeweX/MockFog2/projects). diff --git a/node-manager/playbooks/Playbooks.md b/node-manager/playbooks/README.md similarity index 93% rename from node-manager/playbooks/Playbooks.md rename to node-manager/playbooks/README.md index cdbc5c6..70c6be3 100644 --- a/node-manager/playbooks/Playbooks.md +++ b/node-manager/playbooks/README.md @@ -2,7 +2,7 @@ This document lists required files that need to be available for the playbook of each phase. For each of the files, a list to an example is needed. To understand how these files are created, please study the phases' [javascript code](../lib/stages/) directly. -It also provides example commands with which, if all data is available in the required places, each playbook can be run with ansible directly. +Below, we also provide example commands with which, if all data is available in the required places, each playbook can be run with ansible directly. Each of the example commands assumes to be executed in the `node-manager` directory; mentioned example files are also assumed to be placed, here. It is possible to step through ansible tasks with `--step` and to start at a define task with `--start-at-task`, e.g., `--start-at-task="Create SSH Key"`. @@ -23,7 +23,7 @@ ansible-playbook --ssh-common-args="-o StrictHostKeyChecking=no" playbooks/0101_ Requires: - [./run/vars/0102_agent.yml](../run-example/vars/0102_agent.yml) - `./run/ec2:mockfog2:ssh-key.pem` (key name depends on configuration) -- [./run/hosts](../run-example/config/hosts) +- [./run/hosts](../run-example/hosts) ```bash ansible-playbook --ssh-common-args="-o StrictHostKeyChecking=no" playbooks/0102_agent.yml -i "run/hosts" --key-file="run/ec2:mockfog2:ssh-key.pem" --extra-vars="@run/vars/0102_agent.yml" @@ -49,7 +49,7 @@ ansible-playbook --ssh-common-args="-o StrictHostKeyChecking=no" playbooks/0104_ Requires: - [./run/vars/0201_prepare.yml](../run-example/vars/0201_prepare.yml) - `./run/ec2:mockfog2:ssh-key.pem` (key name depends on configuration) -- [./run/hosts](../run-example/config/hosts) +- [./run/hosts](../run-example/hosts) - container specific vars, e.g., [./run/vars/container/camera.yml](../run-example/vars/container/camera.yml) - container specific environment file, e.g., [./run/appdata/camera/env_file.env](./run-example/appdata/camera/env_file.env) (storage location depends on configuration) @@ -63,7 +63,7 @@ ansible-playbook --ssh-common-args="-o StrictHostKeyChecking=no" playbooks/0201_ Requires: - [./run/vars/0202_start.yml](../run-example/vars/0202_start.yml) - `./run/ec2:mockfog2:ssh-key.pem` (key name depends on configuration) -- [./run/hosts](../run-example/config/hosts) +- [./run/hosts](../run-example/hosts) - container specific vars, e.g., [./run/vars/container/camera.yml](../run-example/vars/container/camera.yml) ```bash @@ -87,7 +87,7 @@ ansible-playbook --ssh-common-args="-o StrictHostKeyChecking=no" playbooks/0203_ Requires: - [./run/vars/0204_collect.yml](../run-example/vars/0204_collect.yml) - `./run/ec2:mockfog2:ssh-key.pem` (key name depends on configuration) -- [./run/hosts](../run-example/config/hosts) +- [./run/hosts](../run-example/hosts) - container specific vars, e.g., [./run/vars/container/camera.yml](../run-example/vars/container/camera.yml) - folder to store results, e.g., `./run/appdata/camera/` (storage location depends on configuration)