From: Dietmar Maurer Date: Thu, 16 Aug 2018 07:31:05 +0000 (+0200) Subject: thumbnail: allow to reference all images inside /images subdir X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=1ff5e4e80ebfdab700d14abbe18da65cbdbb147a thumbnail: allow to reference all images inside /images subdir Before, we was limited to /images/screenshots/ --- diff --git a/README.adoc b/README.adoc index cda72b0..e95a116 100644 --- a/README.adoc +++ b/README.adoc @@ -266,7 +266,7 @@ will point to this link. Screenshots ----------- -[thumbnail="gui-datacenter-search.png"] +[thumbnail="screenshot/gui-datacenter-search.png"] First, it should be noted that we can display screenshots on 'html' and 'wiki' pages, and we can include them in printed documentation. But @@ -276,7 +276,7 @@ depend on the visibility of the screenshot. You can include a screenshot by setting the 'thumbnail' attribute on a paragraph: ---- -[thumbnail="gui-datacenter-search.png"] +[thumbnail="screenshot/gui-datacenter-search.png"] First, it should be noted ... ---- @@ -301,7 +301,7 @@ all image attributes (from debian package 'imagemagick') .Default Screenshot Layout -[thumbnail="gui-datacenter-search.png"] +[thumbnail="screenshot/gui-datacenter-search.png"] We normally display screenshots as small thumbnail on the right side of a paragraph. On printed documentation, we render the full sized @@ -309,14 +309,14 @@ graphic just before the paragraph, or between the title and the text if the paragraph has a title. It is usually a good idea to add a title to paragraph with screenshots. -[thumbnail="gui-datacenter-search.png", float="left"] +[thumbnail="screenshot/gui-datacenter-search.png", float="left"] If you need to render many screenshots, it is possible to place them on the left side, so you can alternate the thumbnail position using the `float` attribute: ---- -[thumbnail="gui-datacenter-search.png", float="left"] +[thumbnail="screenshot/gui-datacenter-search.png", float="left"] If you need to render many screenshots ... ---- diff --git a/asciidoc/mediawiki.conf b/asciidoc/mediawiki.conf index 550ff33..98b182f 100644 --- a/asciidoc/mediawiki.conf +++ b/asciidoc/mediawiki.conf @@ -299,8 +299,8 @@ endif::deprecated-quotes[] # Paragraph substitution. [paragraph]
-{thumbnail#} -{thumbnail#}{alt={thumbnail}} +{thumbnail#}{alt={thumbnail}}{title} {thumbnail#} {thumbnail#} -{thumbnail#} +{thumbnail#} {thumbnail#} {thumbnail#} {alt={thumbnail}} {thumbnail#} diff --git a/asciidoc/pve-html.conf b/asciidoc/pve-html.conf index 74e0d13..5aaf7aa 100644 --- a/asciidoc/pve-html.conf +++ b/asciidoc/pve-html.conf @@ -302,8 +302,8 @@ endif::deprecated-quotes[] # Paragraph substitution. [paragraph]
-{thumbnail#} -{thumbnail#}{alt={thumbnail}} +{thumbnail#}{alt={thumbnail}} include::ha-groups-opts.adoc[] -[thumbnail="gui-ha-manager-add-group.png"] +[thumbnail="screenshot/gui-ha-manager-add-group.png"] A common requirement is that a resource should run on a specific node. Usually the resource is able to run on other nodes, so you can define diff --git a/pct.adoc b/pct.adoc index c509308..9fa6a38 100644 --- a/pct.adoc +++ b/pct.adoc @@ -348,7 +348,7 @@ Container Settings General Settings ~~~~~~~~~~~~~~~~ -[thumbnail="gui-create-ct-general.png"] +[thumbnail="screenshot/gui-create-ct-general.png"] General settings of a container include @@ -393,7 +393,7 @@ or greater than 220. CPU ~~~ -[thumbnail="gui-create-ct-cpu.png"] +[thumbnail="screenshot/gui-create-ct-cpu.png"] You can restrict the number of visible CPUs inside the container using the `cores` option. This is implemented using the Linux 'cpuset' @@ -438,7 +438,7 @@ prioritize some containers. Memory ~~~~~~ -[thumbnail="gui-create-ct-memory.png"] +[thumbnail="screenshot/gui-create-ct-memory.png"] Container memory is controlled using the cgroup memory controller. @@ -457,7 +457,7 @@ swap`). Mount Points ~~~~~~~~~~~~ -[thumbnail="gui-create-ct-root-disk.png"] +[thumbnail="screenshot/gui-create-ct-root-disk.png"] The root mount point is configured with the `rootfs` property, and you can configure up to 10 additional mount points. The corresponding options @@ -545,7 +545,7 @@ NOTE: The contents of device mount points are not backed up when using `vzdump`. Network ~~~~~~~ -[thumbnail="gui-create-ct-network.png"] +[thumbnail="screenshot/gui-create-ct-network.png"] You can configure up to 10 network interfaces for a single container. The corresponding options are called `net0` to `net9`, and @@ -567,7 +567,7 @@ the following command: .Start and Shutdown Order // use the screenshot from qemu - its the same -[thumbnail="gui-qemu-edit-start-order.png"] +[thumbnail="screenshot/gui-qemu-edit-start-order.png"] If you want to fine tune the boot order of your containers, you can use the following parameters : diff --git a/pve-gui.adoc b/pve-gui.adoc index 33b050b..76262bf 100644 --- a/pve-gui.adoc +++ b/pve-gui.adoc @@ -53,7 +53,7 @@ Features Login ----- -[thumbnail="gui-login-window.png"] +[thumbnail="screenshot/gui-login-window.png"] When you connect to the server, you will first see the login window. {pve} supports various authentication backends ('Realm'), and @@ -68,7 +68,7 @@ time. GUI Overview ------------ -[thumbnail="gui-datacenter-summary.png"] +[thumbnail="screenshot/gui-datacenter-summary.png"] The {pve} user interface consists of four regions. @@ -101,7 +101,7 @@ search bar nearside you can search for specific objects (VMs, containers, nodes, ...). This is sometimes faster than selecting an object in the resource tree. -[thumbnail="gui-my-settings.png"] +[thumbnail="screenshot/gui-my-settings.png"] To the right of the search bar we see the identity (login name). The gear symbol is a button opening the 'My Settings' dialog. There you @@ -189,7 +189,7 @@ reference documentation to get more detailed information. Datacenter ~~~~~~~~~~ -[thumbnail="gui-datacenter-search.png"] +[thumbnail="screenshot/gui-datacenter-search.png"] On the datacenter level you can access cluster wide settings and information. @@ -222,7 +222,7 @@ If you like to have more information about this see the corresponding chapter. Nodes ~~~~~ -[thumbnail="gui-node-summary.png"] +[thumbnail="screenshot/gui-node-summary.png"] All belongs of a node can be managed at this level. @@ -255,7 +255,7 @@ All belongs of a node can be managed at this level. Guests ~~~~~~ -[thumbnail="gui-qemu-summary.png"] +[thumbnail="screenshot/gui-qemu-summary.png"] There are two differed kinds of VM types and both types can be converted to a template. One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC). @@ -305,7 +305,7 @@ All available options are listed one below the other. Storage ~~~~~~~ -[thumbnail="gui-storage-summary-local.png"] +[thumbnail="screenshot/gui-storage-summary-local.png"] In this view we have a two partition split view. On the left side we have the storage options @@ -322,7 +322,7 @@ and on the right side the content of the selected option will shown. Pools ~~~~~ -[thumbnail="gui-pool-summary-development.png"] +[thumbnail="screenshot/gui-pool-summary-development.png"] In this view we have a two partition split view. On the left side we have the logical pool options diff --git a/pve-installation.adoc b/pve-installation.adoc index 7e69424..bc064b9 100644 --- a/pve-installation.adoc +++ b/pve-installation.adoc @@ -49,7 +49,7 @@ following: NOTE: By default, the complete server is used and all existing data is removed. -[thumbnail="pve-grub-menu.png"] +[thumbnail="screenshot/pve-grub-menu.png"] Please insert the installation CD-ROM, then boot from that drive. Immediately afterwards you can choose the following menu @@ -80,7 +80,7 @@ Test Memory:: Runs `memtest86+`. This is useful to check if your memory is functional and error free. -[thumbnail="pve-select-target-disk.png"] +[thumbnail="screenshot/pve-select-target-disk.png"] You normally select *Install Proxmox VE* to start the installation. After that you get prompted to select the target hard disk(s). The @@ -94,7 +94,7 @@ ZFS supports several software RAID levels, so this is specially useful if you do not have a hardware RAID controller. The `Options` button lets you select the ZFS RAID level, and you can choose disks there. -[thumbnail="pve-select-location.png", float="left"] +[thumbnail="screenshot/pve-select-location.png", float="left"] The next page just ask for basic configuration options like your location, the time zone and keyboard layout. The location is used to @@ -103,7 +103,7 @@ usually able to auto detect those setting, so you only need to change them in rare situations when auto detection fails, or when you want to use some special keyboard layout not commonly used in your country. -[thumbnail="pve-set-password.png"] +[thumbnail="screenshot/pve-set-password.png"] You then need to specify an email address and the superuser (root) password. The password must have at least 5 characters, but we highly @@ -128,13 +128,13 @@ administrator, for example: All those notification mails will be sent to the specified email address. -[thumbnail="pve-setup-network.png"] +[thumbnail="screenshot/pve-setup-network.png"] The last step is the network configuration. Please note that you can use either IPv4 or IPv6 here, but not both. If you want to configure a dual stack node, you can easily do that after installation. -[thumbnail="pve-installation.png", float="left"] +[thumbnail="screenshot/pve-installation.png", float="left"] If you press `Next` now, installation starts to format disks, and copies packages to the target. Please wait until that is finished, diff --git a/pveceph.adoc b/pveceph.adoc index 20e1883..4132545 100644 --- a/pveceph.adoc +++ b/pveceph.adoc @@ -23,7 +23,7 @@ Manage Ceph Services on Proxmox VE Nodes :pve-toplevel: endif::manvolnum[] -[thumbnail="gui-ceph-status.png"] +[thumbnail="screenshot/gui-ceph-status.png"] {pve} unifies your compute and storage systems, i.e. you can use the same physical nodes within a cluster for both computing (processing VMs and @@ -109,7 +109,7 @@ This sets up an `apt` package repository in Creating initial Ceph configuration ----------------------------------- -[thumbnail="gui-ceph-config.png"] +[thumbnail="screenshot/gui-ceph-config.png"] After installation of packages, you need to create an initial Ceph configuration on just one node, based on your network (`10.10.10.0/24` @@ -131,7 +131,7 @@ Ceph commands without the need to specify a configuration file. Creating Ceph Monitors ---------------------- -[thumbnail="gui-ceph-monitor.png"] +[thumbnail="screenshot/gui-ceph-monitor.png"] The Ceph Monitor (MON) footnote:[Ceph Monitor http://docs.ceph.com/docs/luminous/start/intro/] @@ -174,7 +174,7 @@ pveceph createmgr Creating Ceph OSDs ------------------ -[thumbnail="gui-ceph-osd-status.png"] +[thumbnail="screenshot/gui-ceph-osd-status.png"] via GUI or via CLI as follows: @@ -278,7 +278,7 @@ highly recommended to achieve good performance. Creating Ceph Pools ------------------- -[thumbnail="gui-ceph-pools.png"] +[thumbnail="screenshot/gui-ceph-pools.png"] A pool is a logical group for storing objects. It holds **P**lacement **G**roups (PG), a collection of objects. @@ -395,7 +395,7 @@ separately. Ceph Client ----------- -[thumbnail="gui-ceph-log.png"] +[thumbnail="screenshot/gui-ceph-log.png"] You can then configure {pve} to use such pools to store VM or Container images. Simply use the GUI too add a new `RBD` storage (see diff --git a/pvesr.adoc b/pvesr.adoc index dae3022..2bcc4d9 100644 --- a/pvesr.adoc +++ b/pvesr.adoc @@ -236,7 +236,7 @@ Remember to replace the VMIDs and node names with your respective values. Managing Jobs ------------- -[thumbnail="gui-qemu-add-replication-job.png"] +[thumbnail="screenshot/gui-qemu-add-replication-job.png"] You can use the web GUI to create, modify and remove replication jobs easily. Additionally the command line interface (CLI) tool `pvesr` can be diff --git a/qm-cloud-init.adoc b/qm-cloud-init.adoc index cbb60e4..23750da 100644 --- a/qm-cloud-init.adoc +++ b/qm-cloud-init.adoc @@ -72,7 +72,7 @@ controller type for SCSI drives. .Add Cloud-Init CDROM drive -[thumbnail="gui-cloudinit-hardware.png"] +[thumbnail="screenshot/gui-cloudinit-hardware.png"] The next step is to configure a CDROM drive which will be used to pass the Cloud-Init data to the VM. @@ -109,7 +109,7 @@ qm template 9000 Deploying Cloud-Init Templates ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -[thumbnail="gui-cloudinit-config.png"] +[thumbnail="screenshot/gui-cloudinit-config.png"] You can easily deploy such a template by cloning: diff --git a/qm.adoc b/qm.adoc index 06e88e3..28d2a38 100644 --- a/qm.adoc +++ b/qm.adoc @@ -101,7 +101,7 @@ could incur a performance slowdown, or putting your data at risk. General Settings ~~~~~~~~~~~~~~~~ -[thumbnail="gui-create-vm-general.png"] +[thumbnail="screenshot/gui-create-vm-general.png"] General settings of a VM include @@ -115,7 +115,7 @@ General settings of a VM include OS Settings ~~~~~~~~~~~ -[thumbnail="gui-create-vm-os.png"] +[thumbnail="screenshot/gui-create-vm-os.png"] When creating a VM, setting the proper Operating System(OS) allows {pve} to optimize some low level parameters. For instance Windows OS expect the BIOS @@ -158,7 +158,7 @@ each disk, instead of adding all disks to the same controller. is an older type of paravirtualized controller. It has been superseded by the VirtIO SCSI Controller, in terms of features. -[thumbnail="gui-create-vm-hard-disk.png"] +[thumbnail="screenshot/gui-create-vm-hard-disk.png"] On each controller you attach a number of emulated hard disks, which are backed by a file or a block device residing in the configured storage. The choice of a storage type will determine the format of the hard disk image. Storages which @@ -213,7 +213,7 @@ Note that backups do not currently work with *IO Thread* enabled. CPU ~~~ -[thumbnail="gui-create-vm-cpu.png"] +[thumbnail="screenshot/gui-create-vm-cpu.png"] A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU. This CPU can then contain one or many *cores*, which are independent @@ -418,7 +418,7 @@ For each VM you have the option to set a fixed size memory or asking host. .Fixed Memory Allocation -[thumbnail="gui-create-vm-memory.png"] +[thumbnail="screenshot/gui-create-vm-memory.png"] When setting memory and minimum memory to the same amount {pve} will simply allocate what you specify to your VM. @@ -475,7 +475,7 @@ of RAM available to the host. Network Device ~~~~~~~~~~~~~~ -[thumbnail="gui-create-vm-network.png"] +[thumbnail="screenshot/gui-create-vm-network.png"] Each VM can have many _Network interface controllers_ (NIC), of four different types: @@ -619,7 +619,7 @@ the following command: .Start and Shutdown Order -[thumbnail="gui-qemu-edit-start-order.png"] +[thumbnail="screenshot/gui-qemu-edit-start-order.png"] In some case you want to be able to fine tune the boot order of your VMs, for instance if one of your VM is providing firewalling or DHCP @@ -655,7 +655,7 @@ cluster-wide. Migration --------- -[thumbnail="gui-qemu-migrate.png"] +[thumbnail="screenshot/gui-qemu-migrate.png"] If you have a cluster, you can migrate your VM to another host with @@ -711,7 +711,7 @@ Then the migration will copy the disk over the network to the target host. Copies and Clones ----------------- -[thumbnail="gui-qemu-full-clone.png"] +[thumbnail="screenshot/gui-qemu-full-clone.png"] VM installation is usually done using an installation media (CD-ROM) from the operation system vendor. Depending on the OS, this can be a