Readme.md 2.81 KB
Newer Older
Dmitry Volodin's avatar
Dmitry Volodin committed
1
2
3
# NOC Tower
NOC Tower is the tool for deployment and maintaining multiple
NOC (http://nocproject.org/) installations.
Aleksey Shirokih's avatar
Aleksey Shirokih committed
4

Aleksey Shirokih's avatar
Aleksey Shirokih committed
5
[![build status](https://code.getnoc.com/noc/tower/badges/master/build.svg)](https://code.getnoc.com/noc/tower/commits/master)
Dmitry Volodin's avatar
Dmitry Volodin committed
6

Dmitry Volodin's avatar
Dmitry Volodin committed
7
## Preparation
Aleksey Shirokih's avatar
Fix doc    
Aleksey Shirokih committed
8
### Debian based Linux
Dmitry Volodin's avatar
Dmitry Volodin committed
9
10
```
#!shell
Aleksey Shirokih's avatar
Aleksey Shirokih committed
11
# apt-get install python-virtualenv libffi6 libffi-dev python-dev gcc libssl-dev
Dmitry Volodin's avatar
Dmitry Volodin committed
12
13
14
15
# groupadd tower
# useradd -d /home/tower -g tower -s /bin/bash -m tower
```

16
17
18
19
20
21
## Debian only
```
#!shell
/opt/tower# apt-get install dbus
```

Aleksey Shirokih's avatar
Fix doc    
Aleksey Shirokih committed
22
23
24
### Rhel based Linux
```
#!shell
Aleksey Shirokih's avatar
Aleksey Shirokih committed
25
# yum install python-virtualenv libffi libffi-devel python-devel gcc openssl-devel
Aleksey Shirokih's avatar
Fix doc    
Aleksey Shirokih committed
26
27
28
29
30
# groupadd tower
# useradd -d /home/tower -g tower -s /bin/bash -m tower
```


Dmitry Volodin's avatar
Dmitry Volodin committed
31
32
33
### FreeBSD
```
#!shell
Aleksey Shirokih's avatar
Aleksey Shirokih committed
34
# pkg install -y python2 libffi py27-pip py27-virtualenv py27-sqlite3 ca_root_nss
Dmitry Volodin's avatar
Dmitry Volodin committed
35
# pw groupadd -n tower
36
# pw useradd -g tower -s /bin/csh -d /home/tower -n tower -m
Dmitry Volodin's avatar
Dmitry Volodin committed
37
38
39
```


Dmitry Volodin's avatar
Dmitry Volodin committed
40
## Installation
Dmitry Volodin's avatar
Dmitry Volodin committed
41
42
43
44
Tower is installed into /opt/tower directory by default, though you
can use arbitrary directory (i.e. /usr/local/tower) as well.
Replace /opt/tower/ to directory of your choice

Dmitry Volodin's avatar
Dmitry Volodin committed
45
 - Create Tower directory
46
47
48

```
#!shell
Dmitry Volodin's avatar
Dmitry Volodin committed
49
50
# mkdir /opt/tower
# cd /opt/tower
51
```
Dmitry Volodin's avatar
Dmitry Volodin committed
52
53

 - Create virtualenv
54
55
```
#!shell
Dmitry Volodin's avatar
Dmitry Volodin committed
56
/opt/tower# virtualenv .
57
```
Dmitry Volodin's avatar
Dmitry Volodin committed
58

Dmitry Volodin's avatar
Dmitry Volodin committed
59
60
61
 - Install Tower
```
#!shell
Aleksey Shirokih's avatar
Aleksey Shirokih committed
62
/opt/tower# ./bin/pip install --upgrade pip
Aleksey Shirokih's avatar
Aleksey Shirokih committed
63
/opt/tower# ./bin/pip install https://cdn.getnoc.com/tower/noc-tower-latest.zip
Dmitry Volodin's avatar
Dmitry Volodin committed
64
65
66
/opt/tower# chown -R tower var/
```
 - Generate Tower ssh keys
67
68
```
#!shell
Dmitry Volodin's avatar
Dmitry Volodin committed
69
/opt/tower# su - tower -c "ssh-keygen -t rsa -b 4096"
70
```
Dmitry Volodin's avatar
Dmitry Volodin committed
71

Aleksey Shirokih's avatar
Aleksey Shirokih committed
72
73
74
75
76
77
## For single node installation only
Add user tower to sudo group.
* For example: `adduser tower sudo`
* Select Local installation type with local ip on Nodes screen. 


Dmitry Volodin's avatar
Dmitry Volodin committed
78
 - Run Tower
79
80
```
#!shell
Dmitry Volodin's avatar
Dmitry Volodin committed
81
/opt/tower# su - tower -c "cd /opt/tower && ./bin/tower-web"
82
```
Dmitry Volodin's avatar
Dmitry Volodin committed
83

84
## Deploying
85

Dmitry Volodin's avatar
Dmitry Volodin committed
86
 - Enter the magical mistery tower.
Dmitry Volodin's avatar
Dmitry Volodin committed
87
88
89
90
91
92
93
94
95
96
   Open http://<IP>:8888/ in your browser. Login as admin/admin

 - Set up Tower
 Go to settings and set Tower's site URL (http://<IP>:8888/) and
 Tower's repository URL, as seen by nodes (http://<IP>:8888/hg).

 Do not forget to change tower's admin password
 (Upper right menu > Change Password)

## Prepare nodes
Aleksey Shirokih's avatar
Fix doc    
Aleksey Shirokih committed
97
98
99
100
101
102
103
104
On each node 
* create ansible user (*ansible* by default),
* grant it passwordless sudo privileges and copy Tower's
* copy public ssh key (*/home/tower/.ssh/id_rsa.pub*) to *ansible's*
```
#!shell
/opt/tower# su - tower -c "ssh-copy-id node_ip"
```
Aleksey Shirokih's avatar
Aleksey Shirokih committed
105
106

## RHEL Only
Aleksey Shirokih's avatar
Fix doc    
Aleksey Shirokih committed
107
108
* For RHEL based systems check if "Defaults    requiretty" is commented.
* Ensure python2.7 package installed
Aleksey Shirokih's avatar
Aleksey Shirokih committed
109
* Create new file on tower in /opt/tower/var/tower/playbooks/ENV_NAME/ansible/vars/local.yml with such lines
Aleksey Shirokih's avatar
fix    
Aleksey Shirokih committed
110

Aleksey Shirokih's avatar
Aleksey Shirokih committed
111
112
113
```
rhel_subscription_username: ""
rhel_subscription_password: ""
Aleksey Shirokih's avatar
fix    
Aleksey Shirokih committed
114
```
Aleksey Shirokih's avatar
Aleksey Shirokih committed
115
116
117

## Proxy 
In cause of using proxy for internet acces you should set proxy settings to `/home/tower/.hgrc` that way
Aleksey Shirokih's avatar
fix    
Aleksey Shirokih committed
118

Aleksey Shirokih's avatar
Aleksey Shirokih committed
119
120
121
122
```
[http_proxy]
host=192.168.1.1:3128
```