mirror of
https://github.com/vatesfr/xen-orchestra.git
synced 2026-09-10 22:14:48 -05:00
docs(xo): fix wrong page order and restore missing external links (#10370)
docs(xo): fix wrong page order and restore missing links After ve changed how the sidebar was generated (from manual declarations to automatic generation) Some pages went out of order and didn't have the proper sidebar title. This commit fixes that. Also, the external links in the sidebar disappeared. We can't add them in an auto-generated sidebar, so we circumvent that by creating dedicated pages for external resources and re-adding the links there. Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
This commit is contained in:
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# REST API
|
||||
|
||||
The Xen Orchestra REST API is the modern, public way to automate your infrastructure. We built it from scratch, next to [our historical JSON-RPC API](../getting-started/architecture.md#apis), to be [REST-like](https://en.wikipedia.org/wiki/Representational_state_transfer) and usable with a plain `curl` command. It is now almost complete: nearly all of Xen Orchestra's capabilities are exposed through it, and it is ready to be used in production. It is also the API we are building the future of Xen Orchestra on, so it is the right choice for any new automation.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: Features and settings
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Backup features and settings
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "Backup types",
|
||||
"position": 1,
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "All the different backup types"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Backup strategy guide
|
||||
|
||||
This guide explains how to design and implement a backup strategy in Xen Orchestra.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Backup reports
|
||||
|
||||
At the end of a backup job, Xen Orchestra can send you a report through the channel of your choice: email, XMPP, Slack or Mattermost, and even straight into your Nagios or Icinga 2 monitoring.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Backup troubleshooting
|
||||
|
||||
This page lists the most common errors you can meet with XO backups, what they mean and how to fix them.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Backups in XO 6
|
||||
|
||||
XO 6 puts backup health where you look every day: on the dashboards. This page covers what you can see and follow from XO 6; creating and editing backup jobs is currently done in XO 5 (see [XO 6 and XO 5](../discover-xen-orchestra/xo6vsxo5.md)).
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: Retention calculator
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Backup retention calculator
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
slug: backup
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Backup overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "Scale and security",
|
||||
"position": 2,
|
||||
"position": 6,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Scalability, performance, and security for large-scale deployments"
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: Core concepts
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# How XO 6 is organized
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: First steps
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# XO 6 at a glance
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: What's new
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# What's new in XO 6
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# XO 6 and XO 5
|
||||
|
||||
XO 6 and XO 5 are two interfaces to the same Xen Orchestra. They run side by side, on the same server, against the same data: a VM started in one is instantly running in the other, a backup job created in XO 5 immediately shows its health in XO 6. There is no migration step and nothing to synchronize.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
Xen Orchestra (XO) is built as **one server and several clients**: the two web interfaces ([XO 6](../discover-xen-orchestra/gettingstarted.md) and XO 5), the command line client `xo-cli`, and anything speaking the [REST API](automation/restapi.md). The server, `xo-server`, is the only piece that talks to your infrastructure.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
Once Xen Orchestra is installed, you can configure some parameters in the configuration file. Let's see how to do that.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: From source
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Installing XO from source
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: Installation
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Installing XOA
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
# Replace your XOA
|
||||
|
||||
Replacing your appliance with a fresh one takes three steps: deploy the new XOA, export the configuration of the old one, and import it into the new one. Everything follows: users, ACLs, connected pools, backup jobs, remotes and settings.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Releases
|
||||
|
||||
Xen Orchestra is distributed in two ways: as a turnkey virtual appliance (**XOA**) and **from the sources** on GitHub. Both contain the same Xen Orchestra, including its two web interfaces ([XO 6 and XO 5](../discover-xen-orchestra/xo6vsxo5.md)), the REST API and the backup engine.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Host compatibility list
|
||||
|
||||
Xen Orchestra connects to hosts running [XCP-ng](https://xcp-ng.org/) or [XenServer](https://www.xenserver.com/) (formerly Citrix Hypervisor), and only those: XO is **agent-less** and talks to the XAPI toolstack directly, so a Xen hypervisor installed from a regular Linux distribution will not work (see the [architecture section](architecture.md)).
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
This page covers the problems you may encounter with your XOA, and how to get out of them.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_label: Updates
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Updating XOA
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Users and access",
|
||||
"label": "Guides",
|
||||
"position": 7,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
slug: /
|
||||
sidebar_position: 1
|
||||
sidebar_label: Introduction
|
||||
---
|
||||
|
||||
# Xen Orchestra in a nutshell
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Advanced features
|
||||
|
||||
<InterfaceNote />
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# IPMI
|
||||
|
||||
## Categorizing "unknown" IPMI sensors
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Load balancing
|
||||
|
||||
<InterfaceNote />
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Management in XO 5
|
||||
|
||||
<InterfaceNote>This page describes infrastructure management in the XO 5 interface. XO 6 already covers inspection of pools, hosts, networks and storage, host power actions, network and VIF creation.</InterfaceNote>
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Management in XO 6
|
||||
|
||||
This page walks through day-to-day management in XO 6: pools, hosts and VMs. For the general layout and navigation, start with [XO 6 at a glance](../discover-xen-orchestra/gettingstarted.md).
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# SDN controller
|
||||
|
||||
<InterfaceNote>Private networks are currently created and managed from XO 5. Traffic rules moved ahead in [XO 6](../manage-your-infrastructure/management.md#traffic-rules), with more capabilities than the XO 5 equivalent.</InterfaceNote>
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# VM templates
|
||||
|
||||
<InterfaceNote />
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
slug: project
|
||||
sidebar_label: About
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# About Xen Orchestra
|
||||
|
||||
7
docs/docs/project/project-resources.md
Normal file
7
docs/docs/project/project-resources.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Project resources
|
||||
|
||||
The following resources provide information about the Xen Orchestra project:
|
||||
|
||||
* [Xen Orchestra blog](https://xen-orchestra.com/blog/): News, announcements, and articles about Xen Orchestra.
|
||||
* [Changelog](https://github.com/vatesfr/xen-orchestra/blob/master/CHANGELOG.md#changelog): A list of changes and updates for Xen Orchestra releases.
|
||||
* [Product roadmap](https://docs.vates.tech/product-roadmap/): An overview of planned and upcoming features and improvements.
|
||||
6
docs/docs/support-and-licencing/useful-links.md
Normal file
6
docs/docs/support-and-licencing/useful-links.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# Bundles and licences
|
||||
|
||||
The following resources are available in the Vates VMS documentation:
|
||||
|
||||
- [Vates VMS bundle overview](https://docs.vates.tech/pricing-licencing/vms-bundle-overview/) — Learn about the Vates VMS bundle, its features, and what each subscription includes.
|
||||
- [Applying Xen Orchestra licenses](https://docs.vates.tech/pricing-licencing/applying-xo-licences/) — Learn how to activate and manage a license on your Xen Orchestra Appliance (XOA).
|
||||
Reference in New Issue
Block a user