Skip to content

Commit 8e94c42

Browse files
author
Fernando Lopez
committed
Improve documentation
1 parent 5761c26 commit 8e94c42

3 files changed

Lines changed: 35 additions & 24 deletions

File tree

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,48 @@
11
# docker-fiware
22

3+
[![License badge](https://img.shields.io/badge/license-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4+
35
## Introduction
46

57
Sample docker-compose and configuration files to deploy almost a complete FIWARE architecture example.
68

79
## Install
810

9-
Simple clone the repository in your local folder:
11+
You have two possibilites to deploy this component, locally in your environment or in a virtual machine.
12+
13+
### Install locally
14+
15+
In order to install locally this component you have to keep in mind that you should have installed previously
16+
docker and docker-compose. Please follow the tutorial [Install Docker CE](https://docs.docker.com/install/) in
17+
order to install docker engine and then follow the documentation [Install Docker Compose](https://docs.docker.com/compose/install/).
18+
19+
The next step is simple clone the repository in your local folder:
1020

1121
```bash
1222
git clone https://github.com/flopezag/docker-fiware
1323
```
1424

15-
Once you did it you can go into the IdM Instance and configure your application (in this case the Wirecloud). Remember that in this case you need to put the URL of the application <http://127.0.0.1> and the callback url <http://127.0.0.1/complete/fiware>. Leave the rest of questions without change. Optionally, you can provide some description just to know what is about.
25+
After this step you can launch your services just executing:
1626

17-
Click on Next and Finish the process. It will generage your OAuth2 credentials (Client ID and Client Secret values) of your application. It is needed in order to configure Wirecloud to connect to this IdM instance.
27+
```bash
28+
docker-compose up -d
29+
```
1830

19-
To configure your wirecloud instance just execute the configuration script:
31+
Last but not leasr, to configure your wirecloud instance just execute the configuration script:
2032

2133
```bash
2234
./setup.sh init
2335
```
2436

25-
It will request you the OAuth2 credentials and automatically will change all the parameters in wirecloud in order to use the authentication using your own instance of IdM.
26-
27-
Last but not least, due to internal communication of the Wirecloud it is needed that your /etc/hosts file could include the following line:
37+
It will request you the user name and password of the [IdM](http://127.0.0.1:3000) instance that you have allocated.
38+
Please use the default administration user of the IdM. In order to access the wirecloud just go to the link
39+
[Wirecloud](http://127.0.0.1).
2840

29-
```bash
30-
127.0.0.1 localhost fiware-idm
31-
```
41+
### Install remotelly
3242

33-
## Usage
43+
In order to install and configure the deployment of this dockers, you can take a look to the documentation provided in
44+
deploy folder, [How to deploy it in a specific machine](deploy/README.md)
3445

3546
## License
3647

37-
Apache2.0
48+
These scripts are licensed under Apache License 2.0.

deploy/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setting up a stand-alone FIWARE Lab User Create service
1+
# How to deploy it in a specific machine
22

33
This content describes how to deploy this example of FIWARE services using an
44
[ansible](http://www.ansible.com) playbook. It has been tested on the
@@ -22,15 +22,21 @@ IdM - Keyrock local instance deployed in the docker-compose.
2222

2323
pip install -r requirements.txt
2424

25-
* One all the variables are in place you should be able to deploy and
26-
configure the service. Just run the following command:
25+
* Go into the vars/main.yml and assign the IP of the virtual machine to the variable
26+
ip_address.
27+
28+
* Execute the ansible playbook to deploy and configure the services:
2729

2830
ansible-playbook -vvvv -i inventory.yml \
2931
--private-key=(Key pair to access to the instance) \
3032
deploy_fiware.yml
3133

32-
* Once that the command finish, the last step is going into the virtual machine and execute the command:
34+
* Once that the command finish, the last step is going into the virtual machine and
35+
execute the command:
3336

3437
sudo ./setup.sh init
3538

36-
Which automatically configure the Wirecloud to connect to the local instance of IdM.
39+
Which automatically configure the Wirecloud to connect to the local instance of IdM.
40+
41+
Keep in mind that the deployment and configuration of all the steps could expend some
42+
time. One of our execution expends arround 13 minutes to finish it.

deploy/deploy_fiware.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
register: hostname
6666

6767
- debug:
68-
msg: "{{ hostname }}"
68+
msg: "{{ hostname }}"
6969

7070
- name: add myself and fiware-idm to /etc/hosts
7171
lineinfile:
@@ -175,9 +175,3 @@
175175
become: true
176176
args:
177177
chdir: /home/ubuntu/docker-fiware
178-
179-
- name: Configurte the IdM and Wirecloud to work together
180-
shell: ./setup.sh init
181-
become: true
182-
args:
183-
chdir: /home/ubuntu/docker-fiware

0 commit comments

Comments
 (0)