feat(docs/proxy): SSH connection and second nic (#5777)

This commit is contained in:
Yannick Achy 2021-05-12 09:03:44 +02:00 committed by GitHub
parent cf45cb56ad
commit 7da22094f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,10 +1,10 @@
# Backup Proxy
A Xen Orchestra proxy is an architecture component you can deploy in an infrastructure in order to handle the data stream of your backup job.
A Xen Orchestra proxy is an architecture component you can deploy in your infrastructure in order to locally handle the data streams of your backup jobs.
The most current situation in which you might wish to use a XO proxy are:
- To handle backup data stream in large infrastructure to avoid saturation of the main appliance and split the workload
- To handle backup data stream in remote infrastructure to avoid useless back and forth from the main XOA to the remote location
- To handle backup data streams in large infrastructure to avoid saturation of the main appliance and split the workload
- To handle backup data streams in remote infrastructure to avoid useless back and forth from the main XOA to the remote location
## Architecture
@ -16,11 +16,11 @@ The most current situation in which you might wish to use a XO proxy are:
### Prerequisites
To deploy Xen Orchestra proxies, you need to have an available proxy license. To purchase a license, you simply need to go on [our store](https://xen-orchestra.com/#!/member/purchaser) and follow the process.
To deploy a Xen Orchestra proxy, you need to have an available proxy license. To purchase a license, you simply need to visit [our store](https://xen-orchestra.com/#!/member/purchaser) and follow the purchasing process.
### Minimum Requirements
XO proxies will require this ressources available:
XO proxies require the following resources:
- 2 vCPUs
- 2GiB RAM
@ -28,7 +28,7 @@ XO proxies will require this ressources available:
### Installation
1. Go in the proxies section of your appliance
1. Go to the proxies section of your appliance
![](./assets/proxy-section.png)
@ -36,11 +36,11 @@ XO proxies will require this ressources available:
![](https://user-images.githubusercontent.com/21563339/80114306-b6110480-8583-11ea-8722-83f22e5be778.png)
3. Do all the required configuration for your proxy (SR, network...)
3. Perform all the required configuration for your proxy (SR, network...)
![](https://user-images.githubusercontent.com/21563339/80114537-fe302700-8583-11ea-9bf5-598e0b143021.png)
4. If you have an available license, it will be automatically bind to your new proxy deployed.
4. If you have an available license, it will be automatically bound to your newly deployed proxy.
## Proxy Remote creation
@ -49,8 +49,41 @@ Once a proxy is deployed in your infrastructure, you can create a proxy remote u
![](https://user-images.githubusercontent.com/21563339/80117316-54529980-8587-11ea-9721-8a1d61293efe.png)
![](https://user-images.githubusercontent.com/21563339/80117185-23726480-8587-11ea-8136-50a8d98b4a5a.png)
## Backup job with Proxy
## Backup job with Proxies
While creating a standard backup job from your main Xen Orchestra appliance, you will have the ability to select a proxy on which you want to execute the job.
![](https://user-images.githubusercontent.com/21563339/80116365-29b41100-8586-11ea-9746-e01ca3e53996.png)
## Enabling login to a proxy appliance
Login is disabled by default on proxy appliances.
If you need to login for some reason, you need to set a password for the xoa user via the XenStore of the VM. The following is to be ran on your XCP-ng host:
```
xe vm-param-set uuid=<UUID> xenstore-data:vm-data/system-account-xoa-password=<password>
```
Where UUID is the uuid of your proxy VM.
Then you need to restart the proxy VM.
You can now login through SSH.
## Adding a network card to a Proxy
First you will need to add a second VIF to your Proxy VM. This can be done in the Network tab of the VM in XOA.
After adding the VIF you will need to set an IP for the new NIC, for that you will first need to SSH to the VM [as describe before](/proxy.md#enabling-login-to-proxy-appliance).
Then set the new IP:
```
$ xoa network static eth1
? Static IP for this machine 192.168.100.120
? Network mask (eg 255.255.255.0) 255.255.255.0
```
If you want to set a static address.
```
$ xoa network dhcp eth1
```
If you prefer using DHCP.
:::tip
As XOA uses the first IP address reported by XAPI to contact the proxy appliance, you may have to switch the network card order if you want your proxy to be connected through a specific IP address.
:::