external/HyperProxmox
1
0
Fork 0
mirror of https://github.com/ThomasGsp/HyperProxmox.git synced 2025-03-09 15:40:18 +00:00
Code Issues Releases Wiki Activity

Update 01-prerequisites.md

Browse source 
Update doc
This commit is contained in:
Thomas.GSP 2018-12-18 11:25:15 +00:00 • committed by GitHub
parent 1001074ab5
commit ad1a823b7b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/md/01-prerequisites.md
View file

@ -2,16 +2,16 @@
## Your Proxmox infrastructure ## Your Proxmox infrastructure
For using this project, you need have an pre-existing Proxmox infrastructure. For using this project, you need have an pre-existing Proxmox infrastructure.
If you want just test, a single Proxmox server with some machines is enough. To test, a single Proxmox server with some machines is enough.
In this case, your cluster is represented by your single node. In this case, the cluster is represented by your single node.
You have to the possibility to access on the Proxmox API with an Administrative pve user (not root). You should use a PVE user to access on the Proxmox API setup with administrative permissions.
Setting up Proxmox policies and network is out of scope for this tutorial. Setting up Proxmox policies and network is out of scope for this tutorial.
Report you to the official Proxmox documentation. See the official Proxmox documentation.
## Environment ## Environment
This project need an recent environment to work correctly. This project need a recent environment to work properly.
Typically, in this documentation, we'll use an Debian 9 environment. In this documentation, we'll use an Debian 9 environment.
You can use an other distribution, but just check if theses software are available on your distribution: You can use an other distribution, but just check if theses software are available on your distribution:
* Python 3.4 + with python-redis, pymongo, webpy, python-request, python-crypto * Python 3.4 + with python-redis, pymongo, webpy, python-request, python-crypto
@ -21,18 +21,15 @@ You can use an other distribution, but just check if theses software are availab
This project is separate in two parts: frontend and backend. This project is separate in two parts: frontend and backend.
Backend is writing in python and frontend in PHP/HTML/CSS/JS. Backend is writing in python and frontend in PHP/HTML/CSS/JS.
You have the possibility to use these two parts in different machines, You have the possibility to setup these two parts on different virtual machines,
but due to performance you should use the same (low network latency). but due to performance you should use the same (low network latency).
In more, the API authentication system is currently not implemented and this architecture can expose you In more, the API authentication system is currently not implemented and this kind of architecture can generate security issues.
to security issues.
## Hardware ## Hardware
To run smoothly, the hardware requirement will depend to your goal and infrastructure. To run smoothly, the hardware requirement will depend to your goal and infrastructure.
For a basic test, you can run this project on a very small machine (1cpu/2gb ram/10G disk) without problem. For a basic test, you can run this project on a very small machine (1cpu/2gb ram/10G disk) without problem.
But on a large production system, it can need more resources, especially for the crawler and the databases. But on a large production system, more resources can be necessary, especially for the crawler and the databases.
If your Proxmox infrastructure is very large, the data generated can be really important, If your Proxmox infrastructure is very large, the data generated can be really important,
and cause a slowly working if your hardware is too low. and cause a slowly working if your hardware is too weak.
In some case, it can be necessary to use an independent MongoDB server or cluster.
[Readme](../../README2.md) <-- Previous | Next --> [Setup - Backend](02-backend.md) [Readme](../../README2.md) <-- Previous | Next --> [Setup - Backend](02-backend.md)