Skip to content

Commit 3eb5e22

Browse files
nprimonprimo
committed
first commit
0 parents  commit 3eb5e22

26 files changed

+986
-0
lines changed

‎.env.example

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
INVENTORY_DB_USER=user01
2+
INVENTORY_DB_PASSWORD=password
3+
INVENTORY_DB_NAME=inventory_db
4+
5+
BILLING_DB_USER=user01
6+
BILLING_DB_PASSWORD=password
7+
BILLING_DB_NAME=billing_db
8+
9+
RABBITMQ_USER=rabbit
10+
RABBITMQ_PASSWORD=password
11+
RABBITMQ_QUEUE=billing_queue
12+
13+
RABBITMQ_PORT=5672
14+
INVENTORY_APP_PORT=8000
15+
APIGATEWAY_PORT=3000

‎.gitignore

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/
161+
162+
migrations/
163+
.vagrant/

‎README.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# crud-master
2+
3+
Check more information about this project
4+
[here](https://github.com/01-edu/public/blob/master/subjects/devops/crud-master/README.md).
5+
6+
## Setup
7+
8+
In order to be able to run this application you need to have the following
9+
programs installed on your machine:
10+
11+
- [Vagrant](https://developer.hashicorp.com/vagrant/docs/installation).
12+
- [VirtualBox](https://www.virtualbox.org/wiki/Downloads).
13+
14+
To interact with the application, it is recommended to install the following
15+
programs, or any equivalent ones:
16+
17+
- [Postman](https://www.postman.com/downloads/), or any other tool to
18+
programmatically test API endpoints.
19+
- [DBeaver](https://dbeaver.io/download/), or any other tool to interact and
20+
visualize the content of a SQL database.
21+
22+
To launch the application, follow the below instructions:
23+
24+
- Create a `.env` file in the root of the project folder as the example
25+
provided. You can simply `cp .env.example .env`
26+
- Install _vagrant-env_ plug in running: `vagrant plugin install vagrant-env`
27+
- Run the command `vagrant up` to create all the VMs - this might take a while
28+
depending on the resources of your local machine.
29+
- Interact with the VM cluster using Postman, `curl` or any other tool of your
30+
choice. It is possible to see the IP address of the API Gateway and the port
31+
in the [`config.yaml`](./config.yaml) and [`.env`](./.env) files
32+
33+
To check if everything is working as expected:
34+
35+
- Check that all the VMs are running
36+
37+
```console
38+
$ vagrant status
39+
Current machine states:
40+
41+
BillingVM running (virtualbox)
42+
InventoryVM running (virtualbox)
43+
GatewayVM running (virtualbox)
44+
45+
This environment represents multiple VMs. The VMs are all listed
46+
above with their current state. For more information about a specific
47+
VM, run `vagrant status NAME`.
48+
```
49+
50+
(you should see the same message or a similar one)
51+
52+
- Check that your API Gateway is able to receive HTTP requests. For example,
53+
you should be able to replicate a similar workflow (IP address and port must
54+
be the ones defined in your configuration):
55+
56+
```console
57+
$ curl -X POST -H "Content-Type: application/json" \
58+
-d '{"title": "movie", "description": "wonderful plot"}' \
59+
192.168.56.30:3000/api/movies
60+
{"message":"movie movie inserted successfully"}
61+
$ curl -s 192.168.56.30:3000/api/movies | jq
62+
{
63+
"movies": [
64+
{
65+
"description": "wonderful plot",
66+
"id": 3,
67+
"title": "movie"
68+
}
69+
]
70+
}
71+
$ curl -X DELETE 192.168.56.30:3000/api/movies
72+
{"message":"all movies deleted successfully"}
73+
$ curl 192.168.56.30:3000/api/movies
74+
{"movies":[]}
75+
$
76+
```

0 commit comments

Comments
 (0)