Skip to content

Commit c46055b

Browse files
committed
Revert "update ansible readme; fixes #117"
This reverts commit 700e298.
1 parent 700e298 commit c46055b

File tree

1 file changed

+37
-38
lines changed

1 file changed

+37
-38
lines changed

deploy/ansible/README.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
Copyright 2020-2021 The KNIX Authors
2+
Copyright 2020 The KNIX Authors
33
44
Licensed under the Apache License, Version 2.0 (the "License");
55
you may not use this file except in compliance with the License.
@@ -24,62 +24,61 @@ Tested on the following operating systems on the target machines:
2424

2525
## Prerequisites: on host machine
2626

27-
1. Install dependencies required by ansible
27+
1. Install ansible on host machine
28+
29+
<https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>
30+
31+
2. Install dependencies required by ansible
2832

2933
```bash
3034
# for python2
3135
sudo pip install netaddr
36+
```
37+
or:
38+
39+
```bash
3240
# for python3
3341
sudo pip3 install netaddr
34-
# OR
35-
sudo apt install python-netaddr
3642
```
37-
2. Install ansible on host machine
38-
39-
<https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>
4043

44+
## Prerequisites: on target machines
4145

42-
3. You should be able to ssh into the target machines/VMs without a password. If not then run (on host machine):
46+
1. You can ssh into the target machines/VMs without a password. If not then run (on host machine):
4347

4448
```bash
45-
# if not installed yet
46-
sudo apt-get install ssh
4749
ssh-keygen
48-
# you must ensure the target machine has ssh server installed already (see below)
4950
ssh-copy-id -i ~/.ssh/id_rsa your-username@your-target-hostname
5051
```
5152

52-
## Prerequisites: on target machines
53+
2. The login user (in step 1) on the target machines has been added to the sudoer group
5354

54-
1. Ensure the ssh server is installed
55+
3. Appropriate proxies (/etc/profile, /etc/bash.bashrc, and /etc/apt/apt.conf) are set on target machines
56+
57+
4. `python3`, `python3-dev`, `python3-pip` are installed on each of the target machines
5558

5659
```bash
57-
sudo apt-get install ssh
60+
sudo apt-get update
61+
sudo apt-get install python3 python3-dev python3-pip
5862
```
5963

60-
2. The login user (in step 1) on the target machines should be added to the sudoer group
64+
5. docker-ce is installed on target machines
6165

62-
3. Appropriate proxies (/etc/profile, /etc/bash.bashrc, and /etc/apt/apt.conf) should be set on target machines
66+
* Install docker-ce:
67+
<https://docs.docker.com/install/linux/docker-ce/ubuntu/>
68+
<https://docs.docker.com/install/linux/docker-ce/debian/>
6369

64-
4. Appropriate packages should be installed on target machines:
70+
* Enable sudo-less access to docker commands - add remote user to the docker group
6571

66-
```bash
67-
sudo apt-get update
68-
sudo apt-get install python3 python3-dev python3-pip
69-
# install docker-ce
70-
#<https://docs.docker.com/install/linux/docker-ce/ubuntu/>
71-
#<https://docs.docker.com/install/linux/docker-ce/debian/>
72-
# activate sudo-less access to docker commands
73-
sudo usermod -a -G docker your-username
74-
#if you don't want to log out and in to activate the change to group
75-
newgrp docker
76-
# set docker proxies by updating `/etc/systemd/system/docker.service.d/http-proxy.conf`
77-
sudo apt-get install rustc
78-
```
72+
```bash
73+
sudo usermod -a -G docker your-username
74+
#newgrp docker (if you don't want to log out and in to activate the change to group)
75+
```
7976

80-
5. Ensure that the hostname of the target machine resolves to the correct IP.
77+
* Set docker proxies by updating `/etc/systemd/system/docker.service.d/http-proxy.conf`
8178

82-
6. Remove any old installation of KNIX
79+
6. Hostname of the target machine resolves to the correct IP.
80+
81+
7. Remove any old installation of KNIX
8382

8483
```bash
8584
cd /opt/knix
@@ -89,6 +88,9 @@ Tested on the following operating systems on the target machines:
8988
sudo rm -rf knix
9089
```
9190

91+
*Note: If you find something wrong or missing, please consider opening an issue on [GitHub](https://github.com/knix-microfunctions/knix) and/or letting us know in our [Slack workspace](https://knix.slack.com). Thank you!*
92+
93+
9294
## Installation Steps (to be executed on host machine)
9395

9496
1. Create an `ansible.cfg` file
@@ -117,8 +119,8 @@ Tested on the following operating systems on the target machines:
117119
# For a single remote host installation, the hostname should be added to all groups.
118120
119121
# For a cluster of hosts (preferably 3 or more), all host names must be added to [riak] group.
120-
# [nginx] and [elasticsearch] group should contain a single host.
121-
# At least one host should be in [management] and [triggers_frontend] group.
122+
# Hosts with a NVIDIA GPU should be added to group [gpu_workstations] so that they can be used by KNIX workflow deployments.
123+
# Only one host name (referred to as the <nginx-hostname>) should be added for other groups [elasticsearch], [management], [triggers_frontend], and [nginx].
122124
```
123125

124126
3. Update `settings.json`
@@ -140,8 +142,5 @@ Tested on the following operating systems on the target machines:
140142
```bash
141143
make
142144
```
143-
6. Check *.log files for any errors
144-
145-
7. After installation, open a browser and access `http://<nginx-hostname>:<nginx_http_listen_port>/`
146145
147-
*Note: If you find something wrong or missing, please consider opening an issue on [GitHub](https://github.com/knix-microfunctions/knix) and/or letting us know in our [Slack workspace](https://knix.slack.com). Thank you!*
146+
6. After installation, open a browser and access `http://<nginx-hostname>:<nginx_http_listen_port>/`

0 commit comments

Comments
 (0)