Add nbp-ansible script to deploy opensds northbound plugins
[stor4nfv.git] / ci / nbp-ansible / README.md
1 # nbp-ansible\r
2 This is an installation tool for opensds northbound plugins using ansible.\r
3 \r
4 ## Install work\r
5 \r
6 ### Pre-config (Ubuntu 16.04)\r
7 First download some system packages:\r
8 ```\r
9 sudo apt-get install -y openssh-server git\r
10 ```\r
11 Then config ```/etc/ssh/sshd_config``` file and change one line:\r
12 ```conf\r
13 PermitRootLogin yes\r
14 ```\r
15 Next generate ssh-token:\r
16 ```bash\r
17 ssh-keygen -t rsa\r
18 ssh-copy-id -i ~/.ssh/id_rsa.pub <ip_address> # IP address of the target machine of the installation\r
19 ```\r
20 \r
21 ### Install docker\r
22 If use a standalone cinder as backend, you also need to install docker to run cinder service. Please see the [docker installation document](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) for details.\r
23 \r
24 ### Install ansible tool\r
25 ```bash\r
26 sudo add-apt-repository ppa:ansible/ansible # This step is needed to upgrade ansible to version 2.4.2 which is required for the ceph backend.\r
27 sudo apt-get update\r
28 sudo apt-get install ansible\r
29 ansible --version # Ansible version 2.4.2 or higher is required for ceph; 2.0.0.2 or higher is needed for other backends.\r
30 ```\r
31 \r
32 ### Check if the hosts can be reached\r
33 ```bash\r
34 sudo ansible all -m ping -i nbp.hosts\r
35 ```\r
36 \r
37 ### Run opensds-ansible playbook to start deploy\r
38 ```bash\r
39 sudo ansible-playbook site.yml -i nbp.hosts\r
40 ```\r
41 \r
42 ## Uninstall work\r
43 \r
44 ### Run nbp-ansible playbook to clean the environment\r
45 ```bash\r
46 sudo ansible-playbook clean.yml -i nbp.hosts\r
47 ```\r