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

type/grammar fixes part 9 (#130)

Browse Source 
* Clarification, update links, organize

* add nfs warning, fix debian version

* add ENOSPC troubleshooting

* add more enospc detail

* add note on editing username

* Documentation typo/grammar cleanup part 9
This commit is contained in:
Jon Sands 2018-05-14 16:40:39 -04:00 committed by Olivier Lambert
parent 37c4a9d6ef
commit 67d13bf634
5 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/administration.md
View File

@ -1,6 +1,6 @@
# Administration
This part is about everyday XenServer administration tasks.
This section contains everyday XenServer administration tasks.
* [Home view](user_interface.md)
* [Search and filters](search.md)

18
docs/configuration.md
View File

@ -4,13 +4,13 @@ Once Xen Orchestra is installed, you can configure some parameters in the config
## Configuration
The configuration file is in `/etc/xo-server/config.yaml`.
The configuration file is located at `/etc/xo-server/config.yaml`.
**WARNING: YAML is very strict with indentation: use spaces, not tabs.**
### User to run XO-server as
By default, XO-server is running as 'root'. You can change that by uncommenting these lines and choose whatever user/group you want:
By default, XO-server runs as 'root'. You can change that by uncommenting these lines and choose whatever user/group you want:
```yaml
user: 'nobody'
@ -24,7 +24,7 @@ group: 'nogroup'
### HTTP listen address and port
By default, XO-server listens to all addresses (0.0.0.0) and runs on port 80. You can change this if you want in the `# Basic HTTP` section:
By default, XO-server listens on all addresses (0.0.0.0) and runs on port 80. If you need to, you can change this in the `# Basic HTTP` section:
```yaml
host: '0.0.0.0'
@ -33,7 +33,7 @@ port: 80
### HTTPS
XO-server can also run in HTTPS (both HTTP and HTTPS can cohabit) - just modify what's needed in the `# Basic HTTPS` section, this time with certificates/keys you want and their path:
XO-server can also run in HTTPS (you can run HTTP and HTTPS at the same time) - just modify what's needed in the `# Basic HTTPS` section, this time with the certificates/keys you need and their path:
```yaml
host: '0.0.0.0'
@ -58,7 +58,7 @@ This should be written just before the `mount` option, inside the `http:` block.
### Link to XO-web
You shouldn't have to change this. It's the path were "xo-web" files are served by "xo-server.
You shouldn't have to change this. It's the path where `xo-web` files are served by `xo-server`.
```yaml
mounts:
@ -68,7 +68,7 @@ You shouldn't have to change this. It's the path were "xo-web" files are served
### Custom certificate authority
If you want to use certificates signed by an in-house CA for your XenServer hosts, and have Xen Orchestra connecting to it without rejecting them, you need to add `--use-openssl-ca` option in Node, but also add this CA to your trust store (`/etc/ssl/certs` via `update-ca-certificates` in your XOA).
If you use certificates signed by an in-house CA for your XenServer hosts, and want to have Xen Orchestra connect to them without rejection, you need to add the `--use-openssl-ca` option in Node, but also add the CA to your trust store (`/etc/ssl/certs` via `update-ca-certificates` in your XOA).
To enable this option in your XOA, edit the `/etc/systemd/system/xo-server.service` file and add this:
@ -85,7 +85,7 @@ Don't forget to reload `systemd` conf and restart `xo-server`:
### Redis server
By default, XO-server will try to contact Redis server on `localhost`, with the port `6379`. But you can define anything else you want:
By default, XO-server will try to contact Redis server on `localhost`, with the port `6379`. But you can define whatever you want:
```yaml
uri: 'tcp://db:password@hostname:port'
@ -95,9 +95,9 @@ By default, XO-server will try to contact Redis server on `localhost`, with the
To check if your hosts are up-to-date, we need to access `http://updates.xensource.com/XenServer/updates.xml`.
And to download the patches, access to `http://support.citrix.com/supportkc/filedownload?`.
And to download the patches, we need access to `http://support.citrix.com/supportkc/filedownload?`.
To do that behind a corporate proxy, just add the `httpProxy` variable to fit in your current proxy configuration.
To do that behind a corporate proxy, just add the `httpProxy` variable to match your current proxy configuration.
You can add this at the end of your config file:

2
docs/features.md
View File

@ -2,7 +2,7 @@
All the following features are exposed through the web client, XO-Web, which is using a [responsive design](https://xen-orchestra.com/blog/xen-orchestra-responsive-design/).
We made multiple categories to help you to find what you need:
We've made multiple categories to help you to find what you need:
* [XenServer Administration](administration.html)
* [Docker Support](docker_support.html)

52
docs/search.md
View File

@ -2,50 +2,50 @@
The idea is not just to provide a good search engine, but also a complete solution for managing all your XenServer infrastructure. Ideally:
* less clicks to see or make what you want
* find a subset of interesting object
* make bulk actions on all results found
* sort your result for more pertinent insight
* less clicks to see or do what you need
* find a subset of interesting objects
* perform bulk actions on all results found
* sort your results for more pertinent insight
> Pro Tip: the URL of Xen Orchestra contains the search string, eg `home?s=power_state%3Arunning+`. You can share those URL to your colleagues to share your search!
> Pro Tip: the URL of Xen Orchestra contains the search string, eg `home?s=power_state%3Arunning+`. You can share these URLs to your colleagues to share your search!
## Search examples
We recorded some filters in the dropdown "Filters":
We include some predefined filters in the dropdown "Filters":
![](./assets/xo5presetfilter.png)
You can also use other filters here:
You can use custom filters here:
![](./assets/xo5presetfilter2.png)
## Save your search
If you want to record your filter, just click on "Save" icon ![](./assets/xo5savefilter.png)
If you want to record your filter, just click on the "Save" icon ![](./assets/xo5savefilter.png)
After giving a name to your filter, you can find it in the dropdown filter menu.
After giving a name to your filter, you will be able to find it in the dropdown filter menu.
## Manage your saved search
Just go in your user zone (bottom of main left menu):
Just go into your user panel (bottom of main left menu):
![](./assets/xo5usericon.png)
There, you can edit or remove any filter/search your created!
There, you can edit or remove any filter/search you've created!
## Make a default search
## Set a default search
In this user zone, you can set a default filter (preset filters or your own).
In this user section, you can set a default filter (preset filters or your own).
> Pro Tip: this is saved in your user preference. It means that you can connect anywhere on any browser, you'll find your preference.
> Pro Tip: this is saved in your user preferences. It means that you can connect anywhere on any browser, and you'll still see the same behavior.
## Filter syntax
> A filter allows you to search through a collection of objects which have multiple properties and may even contains other nested objects.
> A filter allows you to search through a collection of objects which have multiple properties and may even contain other nested objects.
#### Searching for a string (or substring)
Simply write the string, if it contains special characters just surround it with quotes:
Simply type the string, if it contains special characters just surround it with quotes:
- `simple-string`
- `"string with special characters like whitespaces"`
@ -54,22 +54,22 @@ Simply write the string, if it contains special characters just surround it with
#### Searching a specific property
Write the property name, followed by a colon `:` and a subfilter:
Type the property name, followed by a colon `:` and a subfilter:
- `name_label:"my VM"`
- `virtualizationMode:hvm`
- `boot:order:cn`
#### Negation
#### Exclusion
Prefix your filter with an exclamation mark `!`:
Prefix your filter with an exclamation mark `!` to exclude any matching results:
- `!hvm`
- `!power_state:Running` or `power_state:!Running`
#### Intersection
Simply write filter's terms side by side:
Simply type the filter's terms side by side:
- `power_state:Halted !virtualizationMode:hvm`
@ -88,16 +88,16 @@ Pipe `|` followed by a group of terms:
#### Truthy property
This one is less common but can be used to check whether a property has a truthy value (`true`, non-empty string or non-zero number).
This one is less common but can be used to check whether a property has a truth-like value (`true`, non-empty string or non-zero number).
Postfix the name of a property by an question mark `?`:
Postfix the name of a property by a question mark `?`:
- `auto_poweron?`
- `high_availability?`
#### Number comparison
You can use the search field/filter with number comparison:
You can use the search field/filter with number comparisons:
* `snapshots:length:>2` (to display VMs with more than 2 snapshots)
* `$VBDs:length:>=4` (VMs with more 4 or more disks attached)
@ -106,11 +106,11 @@ You can use the search field/filter with number comparison:
## Available properties
No documentation on this side either, but you can see all objects and their properties using `xo-cli --list-objects`.
There isn't much documentation listing these (yet), but you can see all objects and their properties using `xo-cli --list-objects`. You can then use these properties for search in XOA.
Take a look at [the documentation](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-cli#xo-cli) :)
Take a look at [the documentation](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-cli#xo-cli) for xo-cli :)
For the Xen Tools status:
Example: to search by the Xen Tools status:
- `xenTools?`: whether the tools are installed
- `xenTools:"up to date"`: whether they are installed and up to date

22
docs/user_interface.md
View File

@ -1,8 +1,8 @@
# Home view
This is home view, what you see when you access your Xen Orchestra URL. It displays all running VMs. This could be configured for your needs (see "Filters section" below).
This is the home view - what you see when you access your Xen Orchestra URL. It displays all running VMs. This can be configured to your needs (see the "Filters section" below).
If you don't have any server connected, you'll see a panel to tell you to add a server:
If you don't have any servers connected, you'll see a panel telling you to add a server:
![](./assets/xo5noserver.png)
@ -16,31 +16,31 @@ After clicking on connect, the server is displayed as connected:
![](./assets/xo5connectedserver.png)
Now go back on Home (or click on the "Xen Orchestra" title on top left of the screen), you'll see the default home view on VMs objects.
Now go back to the Home view (or click on the "Xen Orchestra" title on the top left of the screen), you'll see the default home view of VM objects.
## VMs
This view regroup all **running VMs** on your connected server:
By default, this view groups all **running VMs** on your connected server:
![](./assets/xo5homevms.png)
Let's take a quick tour:
* the global menu is on the left, you can collapse it by clicking on the icon ![](./assets/xo5collapsemenu.png)
* the home view got a header with a type selector (VMs, hosts or pools), a filter zone and a button to create a new VMs
* the VM list also got a header (number of filtered VMs on total VMs) and assisted filters (by pool, host and tags) and a sort menu (by name, memory etc.). You can also expand all VMs details here with the icon ![](./assets/xo5expandhome.png)
* the home view has a header with a type selector (VMs, hosts or pools), a filter zone and a button to create new VMs
* the VM list also has a header (number of filtered VMs and total VMs) and assisted filters (by pool, host and tags) and a sort menu (by name, memory etc.). You can also expand all VMs details here with the icon ![](./assets/xo5expandhome.png)
> Pro Tip: you can edit a VM name, description and even current host by doing a long click on it
> Pro Tip: you can edit a VM name, description and even current host by long clicking on the field
### Bulk actions
You can select multiple objects (eg VMs) at once to make bulk action. The master checkbox will select all, or you can pick anything yourself.
You can select multiple objects (eg VMs) at once to perform a bulk action. The master checkbox will select all, or you can select anything yourself.
After selecting one or more object, an action bar is displayed:
![](./assets/xo5bulk.png)
This will execute action for all those objects!
This will execute the action for all selected objects!
## Hosts
@ -48,9 +48,9 @@ All host objects are displayed:
![](./assets/xo5host.png)
You have power status, name, description, number of CPU core, total memory, management IP and pool name displayed. You can also edit those with a long click.
You have power status, name, description, number of CPU cores, total memory, management IP and pool name displayed. You can also edit these by long clicking.
> Pro Tip: if some hosts had missing patches, you'll see a red dot with the total patches to install. Click on it to go the patch section of the host. See this blog post on [patches for XenServer](https://xen-orchestra.com/blog/hotfix-xs70e004-for-xenserver-7-0/) for more details.
> Pro Tip: If hosts have missing patches, you'll see a red dot with the total patches missing. Click on it to go the patch section of the host. See this blog post on [patches for XenServer](https://xen-orchestra.com/blog/hotfix-xs70e004-for-xenserver-7-0/) for more details.
## Pools