From 9b02037f09ce7607d286c7d382aa915fbca55290 Mon Sep 17 00:00:00 2001 From: matty Date: Fri, 15 Dec 2023 20:42:03 +0330 Subject: [PATCH] doc: Fixed typos Signed-off-by: matty --- doc/api-extensions.md | 12 ++++++------ doc/authentication.md | 6 +++--- doc/backup.md | 2 +- doc/database.md | 2 +- doc/explanation/clustering.md | 4 ++-- doc/explanation/projects.md | 2 +- doc/faq.md | 6 +++--- doc/howto/cluster_form.md | 2 +- doc/howto/cluster_manage.md | 2 +- doc/howto/images_copy.md | 2 +- doc/howto/images_remote.md | 2 +- doc/howto/import_machines_to_instances.md | 6 +++--- doc/howto/initialize.md | 4 ++-- doc/howto/instances_create.md | 2 +- doc/howto/network_bgp.md | 2 +- doc/howto/network_bridge_firewalld.md | 2 +- doc/howto/network_bridge_resolved.md | 2 +- doc/howto/network_create.md | 2 +- doc/howto/network_increase_bandwidth.md | 2 +- doc/howto/network_ipam.md | 4 ++-- doc/howto/network_ovn_setup.md | 6 +++--- doc/howto/network_zones.md | 4 ++-- doc/howto/projects_confine.md | 2 +- doc/howto/storage_pools.md | 2 +- doc/installing.md | 2 +- doc/migration.md | 6 +++--- doc/reference/network_ovn.md | 2 +- doc/reference/remote_image_servers.md | 2 +- doc/reference/server_settings.md | 2 +- doc/reference/storage_ceph.md | 2 +- doc/remotes.md | 2 +- 31 files changed, 50 insertions(+), 50 deletions(-) diff --git a/doc/api-extensions.md b/doc/api-extensions.md index 97cbdefd8e2..45e7b2288b6 100644 --- a/doc/api-extensions.md +++ b/doc/api-extensions.md @@ -73,7 +73,7 @@ And adds support for the following HTTP header on PUT requests: * If-Match (ETag value retrieved through previous GET) -This makes it possible to GET a Incus object, modify it and PUT it without +This makes it possible to GET an Incus object, modify it and PUT it without risking to hit a race condition where Incus or another client modified the object in the meantime. @@ -214,7 +214,7 @@ Rules necessary for `dnsmasq` to work (DHCP/DNS) will always be applied if ## `network_routes` -Introduces `ipv4.routes` and `ipv6.routes` which allow routing additional subnets to a Incus bridge. +Introduces `ipv4.routes` and `ipv6.routes` which allow routing additional subnets to an Incus bridge. ## `storage` @@ -408,7 +408,7 @@ and `xfs`. ## `resources` -This adds support for querying a Incus daemon for the system resources it has +This adds support for querying an Incus daemon for the system resources it has available. ## `kernel_limits` @@ -465,7 +465,7 @@ This makes it possible to retrieve symlinks using the file API. ## `network_leases` Adds a new `/1.0/networks/NAME/leases` API endpoint to query the lease database on -bridges which run a Incus-managed DHCP server. +bridges which run an Incus-managed DHCP server. ## `unix_device_hotplug` @@ -1004,7 +1004,7 @@ redirect file-system mounts to their fuse implementation. To this end, set e.g. ## `container_disk_ceph` -This allows for existing a Ceph RBD or CephFS to be directly connected to a Incus container. +This allows for existing a Ceph RBD or CephFS to be directly connected to an Incus container. ## `virtual-machines` @@ -2222,7 +2222,7 @@ This adds the possibility to import ISO images as custom storage volumes. This adds the `--type` flag to [`incus storage volume import`](incus_storage_volume_import.md). ## `network_allocations` -This adds the possibility to list a Incus deployment's network allocations. +This adds the possibility to list an Incus deployment's network allocations. Through the [`incus network list-allocations`](incus_network_list-allocations.md) command and the `--project | --all-projects` flags, you can list all the used IP addresses, hardware addresses (for instances), resource URIs and whether it uses NAT for diff --git a/doc/authentication.md b/doc/authentication.md index e0da647ab1a..8bccc2a642e 100644 --- a/doc/authentication.md +++ b/doc/authentication.md @@ -37,7 +37,7 @@ any backward compatibility to broken protocol or ciphers. (authentication-trusted-clients)= ### Trusted TLS clients -You can obtain the list of TLS certificates trusted by a Incus server with [`incus config trust list`](incus_config_trust_list.md). +You can obtain the list of TLS certificates trusted by an Incus server with [`incus config trust list`](incus_config_trust_list.md). Trusted clients can be added in either of the following ways: @@ -101,7 +101,7 @@ To enable PKI mode, complete the following steps: 1. Place the certificates issued by the CA on the clients and the server, replacing the automatically generated ones. 1. Restart the server. -In that mode, any connection to a Incus daemon will be done using the +In that mode, any connection to an Incus daemon will be done using the pre-seeded CA certificate. If the server certificate isn't signed by the CA, the connection will simply go through the normal authentication mechanism. @@ -122,7 +122,7 @@ Any user that authenticates through the configured OIDC Identity Provider gets f To configure Incus to use OIDC authentication, set the [`oidc.*`](server-options-oidc) server configuration options. Your OIDC provider must be configured to enable the [Device Authorization Grant](https://oauth.net/2/device-flow/) type. -To add a remote pointing to a Incus server configured with OIDC authentication, run [`incus remote add `](incus_remote_add.md). +To add a remote pointing to an Incus server configured with OIDC authentication, run [`incus remote add `](incus_remote_add.md). You are then prompted to authenticate through your web browser, where you must confirm the device code that Incus uses. The Incus client then retrieves and stores the access and refresh tokens and provides those to Incus for all interactions. diff --git a/doc/backup.md b/doc/backup.md index 9dc349d388f..049a18b04a0 100644 --- a/doc/backup.md +++ b/doc/backup.md @@ -1,5 +1,5 @@ (backups)= -# How to back up a Incus server +# How to back up an Incus server In a production setup, you should always back up the contents of your Incus server. diff --git a/doc/database.md b/doc/database.md index 607f24004e1..eb6890609e3 100644 --- a/doc/database.md +++ b/doc/database.md @@ -9,7 +9,7 @@ With a database, you can run a simple query on the database to retrieve this inf ## Cowsql -In a Incus cluster, all members of the cluster must share the same database state. +In an Incus cluster, all members of the cluster must share the same database state. Therefore, Incus uses [Cowsql](https://github.com/cowsql/cowsql), a distributed version of SQLite. Cowsql provides replication, fault-tolerance, and automatic failover without the need of external database processes. diff --git a/doc/explanation/clustering.md b/doc/explanation/clustering.md index a9ab42fa759..bae437f7223 100644 --- a/doc/explanation/clustering.md +++ b/doc/explanation/clustering.md @@ -12,7 +12,7 @@ If you want to quickly set up a basic Incus cluster, check out [MicroCloud](http (clustering-members)= ## Cluster members -A Incus cluster consists of one bootstrap server and at least two further cluster members. +An Incus cluster consists of one bootstrap server and at least two further cluster members. It stores its state in a [distributed database](../database.md), which is a [Cowsql](https://github.com/cowsql/cowsql/) database replicated using the Raft algorithm. While you could create a cluster with only two members, it is strongly recommended that the number of cluster members be at least three. @@ -116,7 +116,7 @@ The special value of `-1` can be used to have the image copied to all cluster me (cluster-groups)= ## Cluster groups -In a Incus cluster, you can add members to cluster groups. +In an Incus cluster, you can add members to cluster groups. You can use these cluster groups to launch instances on a cluster member that belongs to a subset of all available members. For example, you could create a cluster group for all members that have a GPU and then launch all instances that require a GPU on this cluster group. diff --git a/doc/explanation/projects.md b/doc/explanation/projects.md index d7f85226a91..2611426d495 100644 --- a/doc/explanation/projects.md +++ b/doc/explanation/projects.md @@ -10,7 +10,7 @@ For example, projects can be useful in the following scenarios: You want to keep these instances separate to make it easier to locate and maintain them, and you might want to reuse the same instance names in each customer project for consistency reasons. Each instance in a customer project should use the same base configuration (for example, networks and storage), but the configuration might differ between customer projects. - In this case, you can create a Incus project for each customer project (thus each group of instances) and use different profiles, networks, and storage for each Incus project. + In this case, you can create an Incus project for each customer project (thus each group of instances) and use different profiles, networks, and storage for each Incus project. - Your Incus server is shared between multiple users. Each user runs their own instances, and might want to configure their own profiles. You want to keep the user instances confined, so that each user can interact only with their own instances and cannot see the instances created by other users. diff --git a/doc/faq.md b/doc/faq.md index a6f034e06dd..8882fa677db 100644 --- a/doc/faq.md +++ b/doc/faq.md @@ -47,9 +47,9 @@ Use either of the following methods to grant the required permissions: Privileged containers do not have this issue because all UID/GID in the container are the same as outside. But that's also the cause of most of the security issues with such privileged containers. -## How can I run Docker inside a Incus container? +## How can I run Docker inside an Incus container? -To run Docker inside a Incus container, set the {config:option}`instance-security:security.nesting` property of the container to `true`: +To run Docker inside an Incus container, set the {config:option}`instance-security:security.nesting` property of the container to `true`: incus config set security.nesting true @@ -74,7 +74,7 @@ Various configuration files are stored in that directory, for example: ## Why can I not ping my Incus instance from another host? Many switches do not allow MAC address changes, and will either drop traffic with an incorrect MAC or disable the port totally. -If you can ping a Incus instance from the host, but are not able to ping it from a different host, this could be the cause. +If you can ping an Incus instance from the host, but are not able to ping it from a different host, this could be the cause. The way to diagnose this problem is to run a `tcpdump` on the uplink and you will see either ``ARP Who has `xx.xx.xx.xx` tell `yy.yy.yy.yy` ``, with you sending responses but them not getting acknowledged, or ICMP packets going in and out successfully, but never being received by the other host. diff --git a/doc/howto/cluster_form.md b/doc/howto/cluster_form.md index 8f78ac224cc..d1923674abd 100644 --- a/doc/howto/cluster_form.md +++ b/doc/howto/cluster_form.md @@ -1,7 +1,7 @@ (cluster-form)= # How to form a cluster -When forming a Incus cluster, you start with a bootstrap server. +When forming an Incus cluster, you start with a bootstrap server. This bootstrap server can be an existing Incus server or a newly installed one. After initializing the bootstrap server, you can join additional servers to the cluster. diff --git a/doc/howto/cluster_manage.md b/doc/howto/cluster_manage.md index 215b36b2ecf..154f73c0c11 100644 --- a/doc/howto/cluster_manage.md +++ b/doc/howto/cluster_manage.md @@ -129,7 +129,7 @@ When you upgrade the last member, the blocked members will notice that all serve ## Update the cluster certificate -In a Incus cluster, the API on all servers responds with the same shared certificate, which is usually a standard self-signed certificate with an expiry set to ten years. +In an Incus cluster, the API on all servers responds with the same shared certificate, which is usually a standard self-signed certificate with an expiry set to ten years. The certificate is stored at `/var/lib/incus/cluster.crt` and is the same on all cluster members. diff --git a/doc/howto/images_copy.md b/doc/howto/images_copy.md index 465511099ac..b55493155bd 100644 --- a/doc/howto/images_copy.md +++ b/doc/howto/images_copy.md @@ -57,7 +57,7 @@ See [`incus image import --help`](incus_image_import.md) for all available flags ### Import from a file on a remote web server You can import image files from a remote web server by URL. -This method is an alternative to running a Incus server for the sole purpose of distributing an image to users. +This method is an alternative to running an Incus server for the sole purpose of distributing an image to users. It only requires a basic web server with support for custom headers (see {ref}`images-copy-http-headers`). The image files must be provided as unified images (see {ref}`image-format-unified`). diff --git a/doc/howto/images_remote.md b/doc/howto/images_remote.md index 8fed9fb7b97..16fd2ba48a5 100644 --- a/doc/howto/images_remote.md +++ b/doc/howto/images_remote.md @@ -40,7 +40,7 @@ The URL must use HTTPS. ### Add a remote Incus server -To add a Incus server as a remote, enter the following command: +To add an Incus server as a remote, enter the following command: incus remote add [flags] diff --git a/doc/howto/import_machines_to_instances.md b/doc/howto/import_machines_to_instances.md index 74b0acf2f59..fd9226147da 100644 --- a/doc/howto/import_machines_to_instances.md +++ b/doc/howto/import_machines_to_instances.md @@ -1,10 +1,10 @@ (import-machines-to-instances)= # How to import physical or virtual machines to Incus instances -Incus provides a tool (`incus-migrate`) to create a Incus instance based on an existing disk or image. +Incus provides a tool (`incus-migrate`) to create an Incus instance based on an existing disk or image. You can run the tool on any Linux machine. -It connects to a Incus server and creates a blank instance, which you can configure during or after the migration. +It connects to an Incus server and creates a blank instance, which you can configure during or after the migration. The tool then copies the data from the disk or image that you provide to the instance. ```{note} @@ -51,7 +51,7 @@ The tool can create both containers and virtual machines: ```` -Complete the following steps to migrate an existing machine to a Incus instance: +Complete the following steps to migrate an existing machine to an Incus instance: 1. Download the `bin.linux.incus-migrate` tool ([`bin.linux.incus-migrate.aarch64`](https://github.com/lxc/incus/releases/latest/download/bin.linux.incus-migrate.aarch64) or [`bin.linux.incus-migrate.x86_64`](https://github.com/lxc/incus/releases/latest/download/bin.linux.incus-migrate.x86_64)) from the **Assets** section of the latest [Incus release](https://github.com/lxc/incus/releases). 1. Place the tool on the machine that you want to use to create the instance. diff --git a/doc/howto/initialize.md b/doc/howto/initialize.md index 29da2033251..ca8e854365d 100644 --- a/doc/howto/initialize.md +++ b/doc/howto/initialize.md @@ -1,7 +1,7 @@ (initialize)= # How to initialize Incus -Before you can create a Incus instance, you must configure and initialize Incus. +Before you can create an Incus instance, you must configure and initialize Incus. ## Interactive configuration @@ -120,7 +120,7 @@ Failure modes when overwriting entities are the same as for the `PUT` requests i ```{note} The rollback process might potentially fail, although rarely (typically due to backend bugs or limitations). -You should therefore be careful when trying to reconfigure a Incus daemon via preseed. +You should therefore be careful when trying to reconfigure an Incus daemon via preseed. ``` ### Default profile diff --git a/doc/howto/instances_create.md b/doc/howto/instances_create.md index 0de59373da5..d9c8cfc5649 100644 --- a/doc/howto/instances_create.md +++ b/doc/howto/instances_create.md @@ -18,7 +18,7 @@ Image Unless the image is available locally, you must specify the name of the image server and the name of the image (for example, `images:ubuntu/22.04` for the official 22.04 Ubuntu image). Instance name -: Instance names must be unique within a Incus deployment (also within a cluster). +: Instance names must be unique within an Incus deployment (also within a cluster). See {ref}`instance-properties` for additional requirements. Flags diff --git a/doc/howto/network_bgp.md b/doc/howto/network_bgp.md index e0dd5ad871f..697c498e3fc 100644 --- a/doc/howto/network_bgp.md +++ b/doc/howto/network_bgp.md @@ -11,7 +11,7 @@ If you want to directly route external addresses to specific Incus servers or in Incus will then act as a BGP peer and advertise relevant routes and next hops to external routers, for example, your network router. It automatically establishes sessions with upstream BGP routers and announces the addresses and subnets that it's using. -The BGP server feature can be used to allow a Incus server or cluster to directly use internal/external address space by getting the specific subnets or addresses routed to the correct host. +The BGP server feature can be used to allow an Incus server or cluster to directly use internal/external address space by getting the specific subnets or addresses routed to the correct host. This way, traffic can be forwarded to the target instance. For bridge networks, the following addresses and networks are being advertised: diff --git a/doc/howto/network_bridge_firewalld.md b/doc/howto/network_bridge_firewalld.md index 42808658949..f59c1fc3b73 100644 --- a/doc/howto/network_bridge_firewalld.md +++ b/doc/howto/network_bridge_firewalld.md @@ -117,7 +117,7 @@ There are different ways of working around this problem: Uninstall Docker : The easiest way to prevent such issues is to uninstall Docker from the system that runs Incus and restart the system. - You can run Docker inside a Incus container or virtual machine instead. + You can run Docker inside an Incus container or virtual machine instead. Enable IPv4 forwarding : If uninstalling Docker is not an option, enabling IPv4 forwarding before the Docker service starts will prevent Docker from modifying the global FORWARD policy. diff --git a/doc/howto/network_bridge_resolved.md b/doc/howto/network_bridge_resolved.md index f2ca6ae209f..c9c0a544b09 100644 --- a/doc/howto/network_bridge_resolved.md +++ b/doc/howto/network_bridge_resolved.md @@ -2,7 +2,7 @@ # How to integrate with `systemd-resolved` If the system that runs Incus uses `systemd-resolved` to perform DNS lookups, you should notify `resolved` of the domains that Incus can resolve. -To do so, add the DNS servers and domains provided by a Incus network bridge to the `resolved` configuration. +To do so, add the DNS servers and domains provided by an Incus network bridge to the `resolved` configuration. ```{note} The `dns.mode` option (see {ref}`network-bridge-options`) must be set to `managed` or `dynamic` if you want to use this feature. diff --git a/doc/howto/network_create.md b/doc/howto/network_create.md index e73eac29a39..282c499bc3c 100644 --- a/doc/howto/network_create.md +++ b/doc/howto/network_create.md @@ -47,7 +47,7 @@ If you do not specify a `--type` argument, the default type of `bridge` is used. (network-create-cluster)= ### Create a network in a cluster -If you are running a Incus cluster and want to create a network, you must create the network for each cluster member separately. +If you are running an Incus cluster and want to create a network, you must create the network for each cluster member separately. The reason for this is that the network configuration, for example, the name of the parent network interface, might be different between cluster members. Therefore, you must first create a pending network on each member with the `--target=` flag and the appropriate configuration for the member. diff --git a/doc/howto/network_increase_bandwidth.md b/doc/howto/network_increase_bandwidth.md index 8e5681a84c3..794802dd20a 100644 --- a/doc/howto/network_increase_bandwidth.md +++ b/doc/howto/network_increase_bandwidth.md @@ -4,7 +4,7 @@ You can increase the network bandwidth of your Incus setup by configuring the transmit queue length (`txqueuelen`). This change makes sense in the following scenarios: -- You have a NIC with 1 GbE or higher on a Incus host with a lot of local activity (instance-instance connections or host-instance connections). +- You have a NIC with 1 GbE or higher on an Incus host with a lot of local activity (instance-instance connections or host-instance connections). - You have an internet connection with 1 GbE or higher on your Incus host. The more instances you use, the more you can benefit from this tweak. diff --git a/doc/howto/network_ipam.md b/doc/howto/network_ipam.md index 0baf4facdf0..a2ce04e77e4 100644 --- a/doc/howto/network_ipam.md +++ b/doc/howto/network_ipam.md @@ -1,5 +1,5 @@ (network-ipam)= -# How to display IPAM information of a Incus deployment +# How to display IPAM information of an Incus deployment {abbr}`IPAM (IP Address Management)` is a method used to plan, track, and manage the information associated with a computer network's IP address space. In essence, it's a way of organizing, monitoring, and manipulating the IP space in a network. @@ -33,4 +33,4 @@ The resulting output will look something like this: Each listed entry lists the IP address (in CIDR notation) of one of the following Incus entities: `network`, `network-forward`, `network-load-balancer`, and `instance`. An entry contains an IP address using the CIDR notation. -It also contains a Incus resource URI, the type of the entity, whether it is in NAT mode, and the hardware address (only for the `instance` entity). +It also contains an Incus resource URI, the type of the entity, whether it is in NAT mode, and the hardware address (only for the `instance` entity). diff --git a/doc/howto/network_ovn_setup.md b/doc/howto/network_ovn_setup.md index 7ef9b34920a..90c5a721e5e 100644 --- a/doc/howto/network_ovn_setup.md +++ b/doc/howto/network_ovn_setup.md @@ -42,9 +42,9 @@ Complete the following steps to create a standalone OVN network that is connecte +------+---------+---------------------+----------------------------------------------+-----------+-----------+ ``` -## Set up a Incus cluster on OVN +## Set up an Incus cluster on OVN -Complete the following steps to set up a Incus cluster that uses an OVN network. +Complete the following steps to set up an Incus cluster that uses an OVN network. Just like Incus, the distributed database for OVN must be run on a cluster that consists of an odd number of members. The following instructions use the minimum of three servers, which run both the distributed database for OVN and the OVN controller. @@ -119,7 +119,7 @@ In addition, you can add any number of servers to the Incus cluster that run onl external_ids:ovn-encap-type=geneve \ external_ids:ovn-encap-ip= -1. Create a Incus cluster by running `incus admin init` on all machines. +1. Create an Incus cluster by running `incus admin init` on all machines. On the first machine, create the cluster. Then join the other machines with tokens by running [`incus cluster add `](incus_cluster_add.md) on the first machine and specifying the token when initializing Incus on the other machine. 1. On the first machine, create and configure the uplink network: diff --git a/doc/howto/network_zones.md b/doc/howto/network_zones.md index 8dbbdecfe30..5189d517883 100644 --- a/doc/howto/network_zones.md +++ b/doc/howto/network_zones.md @@ -8,7 +8,7 @@ Network zones are available for the {ref}`network-ovn` and the {ref}`network-bri Network zones can be used to serve DNS records for Incus networks. You can use network zones to automatically maintain valid forward and reverse records for all your instances. -This can be useful if you are operating a Incus cluster with multiple instances across many networks. +This can be useful if you are operating an Incus cluster with multiple instances across many networks. Having DNS records for each instance makes it easier to access network services running on an instance. It is also important when hosting, for example, an outbound SMTP service. @@ -101,7 +101,7 @@ To make use of network zones, you must enable the built-in DNS server. To do so, set the {config:option}`server-core:core.dns_address` configuration option to a local address on the Incus server. To avoid conflicts with an existing DNS we suggest not using the port 53. This is the address on which the DNS server will listen. -Note that in a Incus cluster, the address may be different on each cluster member. +Note that in an Incus cluster, the address may be different on each cluster member. ```{note} The built-in DNS server supports only zone transfers through AXFR. diff --git a/doc/howto/projects_confine.md b/doc/howto/projects_confine.md index 22645a4472f..a376c9cbf23 100644 --- a/doc/howto/projects_confine.md +++ b/doc/howto/projects_confine.md @@ -51,7 +51,7 @@ This is usually achieved by having some users be a member of the `incus` group b Make sure that all user accounts that you want to be able to use Incus are a member of this group. -Once a member of the group issues a Incus command, Incus creates a confined project for this user and switches to this project. +Once a member of the group issues an Incus command, Incus creates a confined project for this user and switches to this project. If Incus has not been {ref}`initialized ` at this point, it is automatically initialized (with the default settings). If you want to customize the project settings, for example, to impose limits or restrictions, you can do so after the project has been created. diff --git a/doc/howto/storage_pools.md b/doc/howto/storage_pools.md index 80f054e3f0e..3a4d465613f 100644 --- a/doc/howto/storage_pools.md +++ b/doc/howto/storage_pools.md @@ -155,7 +155,7 @@ Use the existing Ceph Object Gateway `https://www.example.com/radosgw` to create (storage-pools-cluster)= ### Create a storage pool in a cluster -If you are running a Incus cluster and want to add a storage pool, you must create the storage pool for each cluster member separately. +If you are running an Incus cluster and want to add a storage pool, you must create the storage pool for each cluster member separately. The reason for this is that the configuration, for example, the storage location or the size of the pool, might be different between cluster members. Therefore, you must first create a pending storage pool on each member with the `--target=` flag and the appropriate configuration for the member. diff --git a/doc/installing.md b/doc/installing.md index 2a3dbcef381..531e343065d 100644 --- a/doc/installing.md +++ b/doc/installing.md @@ -336,7 +336,7 @@ Because group membership is normally only applied at login, you might need to ei ## Upgrade Incus After upgrading Incus to a newer version, Incus might need to update its database to a new schema. -This update happens automatically when the daemon starts up after a Incus upgrade. +This update happens automatically when the daemon starts up after an Incus upgrade. A backup of the database before the update is stored in the same location as the active database (at `/var/lib/incus/database`). ```{important} diff --git a/doc/migration.md b/doc/migration.md index 7c40b07c2ee..77804905002 100644 --- a/doc/migration.md +++ b/doc/migration.md @@ -4,19 +4,19 @@ Incus provides tools and functionality to migrate instances in different contexts. Migrate existing Incus instances between servers -: The most basic kind of migration is if you have a Incus instance on one server and want to move it to a different Incus server. +: The most basic kind of migration is if you have an Incus instance on one server and want to move it to a different Incus server. For virtual machines, you can do that as a live migration, which means that you can migrate your VM while it is running and there will be no downtime. See {ref}`move-instances` for more information. Migrate physical or virtual machines to Incus instances -: If you have an existing machine, either physical or virtual (VM or container), you can use the `incus-migrate` tool to create a Incus instance based on your existing machine. +: If you have an existing machine, either physical or virtual (VM or container), you can use the `incus-migrate` tool to create an Incus instance based on your existing machine. The tool copies the provided partition, disk or image to the Incus storage pool of the provided Incus server, sets up an instance using that storage and allows you to configure additional settings for the new instance. See {ref}`import-machines-to-instances` for more information. Migrate instances from LXC to Incus -: If you are using LXC and want to migrate all or some of your LXC containers to a Incus installation on the same machine, you can use the `lxc-to-incus` tool. +: If you are using LXC and want to migrate all or some of your LXC containers to an Incus installation on the same machine, you can use the `lxc-to-incus` tool. The tool analyzes the LXC configuration and copies the data and configuration of your existing LXC containers into new Incus containers. See {ref}`migrate-from-lxc` for more information. diff --git a/doc/reference/network_ovn.md b/doc/reference/network_ovn.md index 4e382d6b92c..5025ef8e4c2 100644 --- a/doc/reference/network_ovn.md +++ b/doc/reference/network_ovn.md @@ -10,7 +10,7 @@ See [`www.ovn.org`](https://www.ovn.org/) for more information. The `ovn` network type allows to create logical networks using the OVN {abbr}`SDN (software-defined networking)`. This kind of network can be useful for labs and multi-tenant environments where the same logical subnets are used in multiple discrete networks. -A Incus OVN network can be connected to an existing managed {ref}`network-bridge` or {ref}`network-physical` to gain access to the wider network. +An Incus OVN network can be connected to an existing managed {ref}`network-bridge` or {ref}`network-physical` to gain access to the wider network. By default, all connections from the OVN logical networks are NATed to an IP allocated from the uplink network. See {ref}`network-ovn-setup` for basic instructions for setting up an OVN network. diff --git a/doc/reference/remote_image_servers.md b/doc/reference/remote_image_servers.md index 4d979547631..935eb5e7d72 100644 --- a/doc/reference/remote_image_servers.md +++ b/doc/reference/remote_image_servers.md @@ -21,7 +21,7 @@ Simple streams servers Public Incus servers : Incus servers that are used solely to serve images and do not run instances themselves. - To make a Incus server publicly available over the network on port 8443, set the {config:option}`server-core:core.https_address` configuration option to `:8443` and do not configure any authentication methods (see {ref}`server-expose` for more information). + To make an Incus server publicly available over the network on port 8443, set the {config:option}`server-core:core.https_address` configuration option to `:8443` and do not configure any authentication methods (see {ref}`server-expose` for more information). Then set the images that you want to share to `public`. Incus servers diff --git a/doc/reference/server_settings.md b/doc/reference/server_settings.md index ff1328fc795..34ec2d69742 100644 --- a/doc/reference/server_settings.md +++ b/doc/reference/server_settings.md @@ -1,5 +1,5 @@ (server-settings)= -# Server settings for a Incus production setup +# Server settings for an Incus production setup To allow your Incus server to run a large number of instances, configure the following settings to avoid hitting server limits. diff --git a/doc/reference/storage_ceph.md b/doc/reference/storage_ceph.md index b0a26a9da1a..fcea52931a9 100644 --- a/doc/reference/storage_ceph.md +++ b/doc/reference/storage_ceph.md @@ -50,7 +50,7 @@ The `ceph` driver in Incus uses RBD images for images, and snapshots and clones Incus assumes that it has full control over the OSD storage pool. -Therefore, you should never maintain any file system entities that are not owned by Incus in a Incus OSD storage pool, because Incus might delete them. +Therefore, you should never maintain any file system entities that are not owned by Incus in an Incus OSD storage pool, because Incus might delete them. Due to the way copy-on-write works in Ceph RBD, parent RBD images can't be removed until all children are gone. diff --git a/doc/remotes.md b/doc/remotes.md index bc8ef007a56..65c36e280f4 100644 --- a/doc/remotes.md +++ b/doc/remotes.md @@ -12,7 +12,7 @@ For example, you can manage instances or update the server configuration on the ## Authentication -To be able to add a Incus server as a remote server, the server's API must be exposed, which means that its {config:option}`server-core:core.https_address` server configuration option must be set. +To be able to add an Incus server as a remote server, the server's API must be exposed, which means that its {config:option}`server-core:core.https_address` server configuration option must be set. When adding the server, you must then authenticate with it using the chosen method for {ref}`authentication`.