NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(doc): remove useless files

Browse Source
This commit is contained in:
Olivier Lambert 2016-11-03 13:26:07 +01:00
parent 72f0f8602d
commit f6f749d583
3 changed files with 0 additions and 222 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/architecture.md
View File

@ -1,27 +0,0 @@
# Architecture
Xen Orchestra (XO) is a software built with a server and clients, such as the web client, `xo-web`, but also a CLI capable client, called `xo-cli`.
> XO is totally agent-less: it means that you don't have to install any program on your hosts to get it working!
## XOA
*Xen Orchestra virtual Appliance* (XOA) is a virtual machine with Xen Orchestra already installed, thus working out-of-the-box.
This is the easiest way to try Xen Orchestra in a minute.
Your XOA is connected to all your hosts, or on the pool master only if you are using Pools in XenServer:
![](https://xen-orchestra.com/assets/partner2.jpg)
## Xen Orchestra (XO)
![](./assets/xo-arch.jpg)
Xen Orchestra itself is built as a modular solution. Each part has its role:
- the core is "[xo-server](https://github.com/vatesfr/xo-server)", a daemon dealing directly with XenServer or XAPI capable hosts. This is where users are stored, and it's the center point for talking to your whole Xen infrastructure.
- the Web interface is in "[xo-web](https://github.com/vatesfr/xo-web)": you are running it directly in your browser. The connection with "xo-server" is done via *WebSockets*.
- "[xo-cli](https://github.com/vatesfr/xo-cli)" is a module allowing to send commands directly from the command line.
We already have other modules around it (like the LDAP plugin for example). It allows to use this modular architecture to add further parts later. It's completely flexible, allowing us to adapt Xen Orchestra in every existing work-flow.

108
doc/updater.md
View File

@ -1,108 +0,0 @@
# Updater
The updater is the central piece to get your XOA on the latest bits of Xen Orchestra.
It allows also to transform your current version in any others (Trial, Starter, Enterprise or Premium) **without downloading a new XOA**.
> By design, the updater is only available in XOA. If you are using the XO from the sources, you'll have to use `git` commands and rebuild to keep up.
## Requierements
In order to work, the updater needs to access to xen-orchestra.com (port 443).
## Usage
The updater is configurable directly in the web interface, or via the CLI.
### From the web interface
By default for a new XOA, you'll have this icon in the top right:
![](./assets/updater_notreg.png)
It means your appliance is not registered. Click on this icon and follow the next step.
#### Register
Updates and trial will be available as soon as you registered your appliance. To register, use your https://xen-orchestra.com credentials you gave to download it previously (your email and your password):
![](./assets/updater_reg.png)
#### Check for new versions
The updater will check for new versions periodically. Nevertheless, if you want to start a manual check, you can do it by clicking on the "Check for updates" icon.
#### Upgrade
If a new version is found, you'll have an upgrade button displayed:
![](./assets/regupdate.png)
**In case where the updater is updated itself, you should have to refresh manually the status panel!**
This could be done by clicking on the refresh white icon:
![](./assets/refreshupdater.png)
#### Proxy configuration
If you are behind a proxy, you can edit your proxy settings in this panel:
![](./assets/regproxy.png)
### From the CLI
If you interface is not accessible, or you just prefer to use CLIs commands, it's totally possible to do all the operations. You need to access your XOA by SSH (remember the default credentials: root/xoa. Change them ASAP).
#### Register
```
# xoa-updater --register
Successfully connected to xoa-updater-service
Please enter your xen-orchestra.com identifiers to register your XOA:
? Email: myemail@example.net
? Password: *****
ℹ Your Xen Orchestra Appliance has been succesfully registered
```
#### Check for new versions
```
# xoa-updater
Successfully connected to xoa-updater-service
Checking new versions...ok ✔
New versions available:
xo-server 4.8.1
ℹ xoa-updater may be run again to upgrade packages
```
#### Upgrade
```
# xoa-updater --upgrade
Successfully connected to xoa-updater-service
Checking new versions...ok ✔
New versions available:
xo-server 4.8.1
[...]
Downloading packages...
Installing new packages...
✔ Your XOA has been successfully updated.
```
## Troubleshooting
If your updater is down, you can restart it with `systemctl restart xoa-updater`.
If you can't fetch updates, make some checks from your XOA:
* you should be able to successfully `ping xen-orchestra.com`
* if not, check your `/etc/resolv.conf` file and modify it if necessary (give a correct DNS server)
* use `ifconfig` to check your network configuration
* check your firewall(s) and allow XOA to reach xen-orchestra.com (port 443)

87
doc/xo-server.md
View File

@ -1,87 +0,0 @@
# xo-server
XO-Server is the core of Xen Orchestra. Its central role opens a lot of possibilities versus other solutions. Let's see why.
### Daemon mode
As a daemon, XO-server is always up. In this way, it can listen and record every event occurring on your whole Xen infrastructure. Connections are always open and it can cache informations before serve it to another client (CLI, Web or anything else).
### Central point
Contrary to XenCenter, each Xen Orchestra's client is connected to one XO-Server, and not all the Xen servers. With a traditional architecture:
![](./assets/without-xo.jpg)
You can see how we avoid a lost of resources and bandwidth waste with a central point:
![](./assets/with-xo.jpg)
### Events
Legacy interfaces use the "pull" model, requesting data every "x" seconds:
![](./assets/noevent.jpg)
It's **not scalable** and slow.
With XO < 3.4, we used events in this way:
![](./assets/semievent.jpg)
But interface was still lagging behind the server. With XO 3.4, we got a full event system, allowing instant display of what's happening on your infrastructure:
![](./assets/fullevent.jpg)
### A proxy for your hosts
XO-Server will act as a proxy for all your clients. It opens a lot of possibilities!
#### Console proxy
A good example is the console: you can now expose your consoles even if your clients are outside the network!
![](https://xen-orchestra.com/blog/content/images/2015/03/console_before.png)
![](https://xen-orchestra.com/blog/content/images/2015/03/console_after.png)
#### VM streaming
Another possibility is to stream a VM from a host to another.
To do that previously, you needed to export your VM somewhere, then re-import it:
![](https://xen-orchestra.com/blog/content/images/2015/10/oldsolution.png)
Thanks to our architecture, it's now far better:
![](https://xen-orchestra.com/blog/content/images/2015/10/newsolution.png)
#### Patching on the fly
To install a patch manually, you need a lot of steps: find, download, extract and apply the patch, sequentially.
"xo-server" can do all these steps once:
1. downloading automatically the patch on Citrix servers
2. unzip it and uploading it on the fly to your host
3. apply it as soon it's done
### Pluggable
It's really easy to plug other modules to XO-server, and extend or adapt the solution to your needs (see XO-web and XO-cli for real examples).
#### ACLs
![](https://xen-orchestra.com/blog/content/images/2014/Aug/ldap.jpg)
![](https://xen-orchestra.com/blog/content/images/2014/Aug/permissions.jpg)
### API
An API is available to communicate directly with XO-Server. This part will be explained later.
### NodeJS under the hood
[NodeJS](https://en.wikipedia.org/wiki/Nodejs) is a software platform for scalable server-side and networking applications. It's famous for its efficiency, scalability and its asynchronous capabilities. Exactly what we need! Thus, XO-server is written in JavaScript.