Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use symlink to common #2505

Merged
merged 3 commits into from
May 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,9 @@ exclude:
- CONTRIBUTING.md
- CODEOWNERS
# avoid generating paginated asciidoc content
- documentation/common/**/*.adoc
- documentation/administration_guide/appe*
- documentation/common/**/*
sandrobonazzola marked this conversation as resolved.
Show resolved Hide resolved
- documentation/**/appe*
- documentation/**/common/**/*.adoc
- documentation/administration_guide/chap*
- documentation/administration_guide/part*
- documentation/administration_guide/topics
Expand All @@ -154,11 +155,9 @@ exclude:
- documentation/upgrade_guide/assembly*
- documentation/upgrade_guide/chap-*
- documentation/upgrade_guide/topics
- documentation/virtual_machine_management_guide/appe*
- documentation/virtual_machine_management_guide/chap*
- documentation/virtual_machine_management_guide/topics
- documentation/virtual_machine_management_guide/assembly*

sass:
add_charset: true
style: :compressed
Expand Down
14 changes: 14 additions & 0 deletions source/_plugins/jekyll_watch_symlink_workaround.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# see https://github.com/oVirt/ovirt-site/pull/2505
# borrowed from https://github.com/guard/listen/issues/339#issue-101785791
require 'listen/record/symlink_detector'
module Listen
class Record
class SymlinkDetector
def _fail(_, _)
# don't warn, noisy
# keep the exception to skip listing on the symlink target in _fast_build_dir()
raise ::Listen::Error::SymlinkLoop, 'Failed due to looped symlinks'
end
end
end
end
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ include::topics/Installing_and_Configuring_a_Squid_Proxy.adoc[]

include::topics/Websocket_Proxy_Overview.adoc[]

// include::../common/admin/proc-Migrating_the_Websocket_Proxy_to_a_Separate_Machine.adoc[leveloffset=+3]
// include::common/admin/proc-Migrating_the_Websocket_Proxy_to_a_Separate_Machine.adoc[leveloffset=+3]

:context!: proxy_admin
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,30 @@ include::topics/Restoring_a_Backup_with_the_engine-backup_Command.adoc[]

include::topics/Restoring_a_Backup_to_a_Fresh_Installation.adoc[]

include::../common/backup-restore/proc-Restoring_a_Backup_to_Overwrite_an_Existing_Installation.adoc[leveloffset=+3]
include::common/backup-restore/proc-Restoring_a_Backup_to_Overwrite_an_Existing_Installation.adoc[leveloffset=+3]

include::topics/Restoring_a_Backup_with_Different_Credentials.adoc[]

include::../common/backup-restore/assembly-Backing_up_and_Restoring_a_Self-Hosted_Engine.adoc[leveloffset=+3]
include::common/backup-restore/assembly-Backing_up_and_Restoring_a_Self-Hosted_Engine.adoc[leveloffset=+3]

include::../common/backup-restore/assembly-Recovering_a_Self-Hosted_Engine.adoc[leveloffset=+3]
include::common/backup-restore/assembly-Recovering_a_Self-Hosted_Engine.adoc[leveloffset=+3]

include::../common/backup-restore/assembly-Overwriting_a_Self-Hosted_Engine.adoc[leveloffset=+3]
include::common/backup-restore/assembly-Overwriting_a_Self-Hosted_Engine.adoc[leveloffset=+3]

[[migrating-rhv-databases]]
=== Migrating {virt-product-fullname} Databases to Remote Servers

:context: migrate_database

include::../common/database/proc-Migrating_the_Manager_database_to_a_remote_server.adoc[leveloffset=+3]
include::common/database/proc-Migrating_the_Manager_database_to_a_remote_server.adoc[leveloffset=+3]
//Adding back context
:context: migrate_database

include::../common/database/proc-Migrating_the_self-hosted_engine_database_to_a_remote_server.adoc[leveloffset=+3]
include::common/database/proc-Migrating_the_self-hosted_engine_database_to_a_remote_server.adoc[leveloffset=+3]
//Adding back context
:context: migrate_database

include::../common/database/assembly-Migrating_Data_Warehouse_to_a_Separate_Machine.adoc[leveloffset=+3]
include::common/database/assembly-Migrating_Data_Warehouse_to_a_Separate_Machine.adoc[leveloffset=+3]

:context!: migrate_database

Expand Down
8 changes: 4 additions & 4 deletions source/documentation/administration_guide/chap-Clusters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ include::topics/Removing_a_cluster.adoc[leveloffset=-1]

include::topics/Memory_Optimization.adoc[leveloffset=-1]

include::../common/admin/con_UEFI_Q35_explanation.adoc[leveloffset=+2]
include::common/admin/con_UEFI_Q35_explanation.adoc[leveloffset=+2]

include::../common/admin/proc_Configuring_cluster_to_use_Q35_or_UEFI.adoc[leveloffset=+3]
include::common/admin/proc_Configuring_cluster_to_use_Q35_or_UEFI.adoc[leveloffset=+3]

include::../common/admin/proc_Configuring_vm_to_use_Q35_or_UEFI.adoc[leveloffset=+3]
include::common/admin/proc_Configuring_vm_to_use_Q35_or_UEFI.adoc[leveloffset=+3]


:context: admin
:admin:
include::../common/upgrade/proc-Changing_the_Cluster_Compatibility_Version.adoc[leveloffset=+2]
include::common/upgrade/proc-Changing_the_Cluster_Compatibility_Version.adoc[leveloffset=+2]
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ include::topics/Changing_the_Data_Center_Storage_Type.adoc[leveloffset=-1]

:context: admin
:admin:
include::../common/upgrade/proc-Changing_the_Data_Center_Compatibility_Version.adoc[leveloffset=+2]
include::common/upgrade/proc-Changing_the_Data_Center_Compatibility_Version.adoc[leveloffset=+2]

[[sect-Data_Centers_and_Storage_Domains]]
== Data Centers and Storage Domains
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ include::topics/Managing_System_Permissions_for_a_Virtual_Disk.adoc[]
include::topics/Virtual_Disk_User_Roles_Explained.adoc[]

:context: system_permissions
include::../common/admin/proc-Setting_Legacy_SPICE_Cipher.adoc[leveloffset=+3]
include::common/admin/proc-Setting_Legacy_SPICE_Cipher.adoc[leveloffset=+3]


[[sect-Scheduling_Policies]]
Expand Down
8 changes: 4 additions & 4 deletions source/documentation/administration_guide/chap-Hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include::topics/Satellite_Host_Provider_Hosts.adoc[]
=== Host Tasks
:context: host_tasks

include::../common/install/proc-Adding_standard_hosts_to_the_Manager.adoc[leveloffset=+3]
include::common/install/proc-Adding_standard_hosts_to_the_Manager.adoc[leveloffset=+3]

include::topics/Adding_a_Satellite_Host_Provider_Host.adoc[]

Expand All @@ -40,7 +40,7 @@ include::topics/Configuring_Host_Power_Management_Settings.adoc[]

include::topics/Configuring_Host_SPM_Settings.adoc[]

include::../common/install/proc-Configuring_a_Host_for_PCI_Passthrough.adoc[leveloffset=+3]
include::common/install/proc-Configuring_a_Host_for_PCI_Passthrough.adoc[leveloffset=+3]

include::topics/Moving_a_host_to_maintenance_mode.adoc[]

Expand All @@ -53,7 +53,7 @@ include::topics/Removing_a_host.adoc[]
include::topics/Updating_a_host_between_minor_releases.adoc[leveloffset=+3]

:admin:
include::../common/install/proc-Reinstalling_Hosts.adoc[leveloffset=+3]
include::common/install/proc-Reinstalling_Hosts.adoc[leveloffset=+3]
:admin!:

:context: host_tasks
Expand All @@ -66,7 +66,7 @@ include::topics/Viewing_Host_Devices.adoc[]

include::topics/Accessing_Cockpit_from_the_Admin_Portal.adoc[]

include::../common/admin/proc-Setting_Legacy_SPICE_Cipher.adoc[leveloffset=+3]
include::common/admin/proc-Setting_Legacy_SPICE_Cipher.adoc[leveloffset=+3]

:context!: host_tasks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ include::topics/Adding_Network_Labels_to_Host_Network_Interfaces.adoc[]

include::topics/Changing_the_FQDN_of_a_Host.adoc[]

include::../common/network/con-IPv6_Networking_Support.adoc[leveloffset=+3]
include::common/network/con-IPv6_Networking_Support.adoc[leveloffset=+3]

include::../common/sriov/assembly-Set_Up_and_Configure_SR-IOV.adoc[leveloffset=+3]
include::common/sriov/assembly-Set_Up_and_Configure_SR-IOV.adoc[leveloffset=+3]
:Network!:

[[sect-Network_Bonding]]
Expand Down
26 changes: 13 additions & 13 deletions source/documentation/administration_guide/chap-Storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,40 +55,40 @@ include::topics/Understanding_Storage.adoc[]
[[sect-Preparing_and_Adding_NFS_Storage]]
=== Preparing and Adding NFS Storage

include::../common/storage/proc-Preparing_NFS_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Preparing_NFS_Storage.adoc[leveloffset=+3]

include::../common/storage/proc-Adding_NFS_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Adding_NFS_Storage.adoc[leveloffset=+3]

include::topics/Increasing_NFS_Storage.adoc[]

[[sect-Preparing_and_Adding_Local_Storage]]
=== Preparing and Adding Local Storage

include::../common/storage/proc-Preparing_Local_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Preparing_Local_Storage.adoc[leveloffset=+3]

include::../common/storage/proc-Adding_Local_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Adding_Local_Storage.adoc[leveloffset=+3]

[[sect-Preparing_and_Adding_POSIX_Compliant_File_System_Storage]]
=== Preparing and Adding POSIX-compliant File System Storage

include::../common/storage/ref-Preparing_POSIX_Storage.adoc[leveloffset=+3]
include::common/storage/ref-Preparing_POSIX_Storage.adoc[leveloffset=+3]

include::../common/storage/proc-Adding_POSIX_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Adding_POSIX_Storage.adoc[leveloffset=+3]

[[sect-Preparing_and_Adding_Block_Storage]]
=== Preparing and Adding Block Storage

include::../common/storage/ref-Preparing_iSCSI_Storage.adoc[leveloffset=+3]
include::common/storage/ref-Preparing_iSCSI_Storage.adoc[leveloffset=+3]

include::../common/storage/proc-Adding_iSCSI_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Adding_iSCSI_Storage.adoc[leveloffset=+3]

include::topics/Configuring_iSCSI_Multipathing.adoc[]

include::topics/proc-Migrating_a_logical_network_to_an_iscsi_bond.adoc[leveloffset=+3]

include::../common/storage/ref-Preparing_FCP_Storage.adoc[leveloffset=+3]
include::common/storage/ref-Preparing_FCP_Storage.adoc[leveloffset=+3]

include::../common/storage/proc-Adding_FCP_Storage.adoc[leveloffset=+3]
include::common/storage/proc-Adding_FCP_Storage.adoc[leveloffset=+3]

include::topics/Increasing_iSCSI_or_FCP_Storage.adoc[]

Expand All @@ -97,9 +97,9 @@ include::topics/Reusing_LUNs.adoc[]
[[Adding_Red_Hat_Gluster_Storage]]
=== Preparing and Adding {gluster-storage-fullname}

include::../common/storage/ref-Preparing_Red_Hat_Gluster_Storage.adoc[leveloffset=+3]
include::common/storage/ref-Preparing_Red_Hat_Gluster_Storage.adoc[leveloffset=+3]

include::../common/storage/ref-Adding_Red_Hat_Gluster_Storage.adoc[leveloffset=+3]
include::common/storage/ref-Adding_Red_Hat_Gluster_Storage.adoc[leveloffset=+3]


[[sect-Importing_Existing_Storage_Domains]]
Expand Down Expand Up @@ -138,7 +138,7 @@ include::topics/Detaching_a_storage_domain.adoc[]

include::topics/Attaching_a_storage_domain.adoc[]

include::../common/storage/proc-Removing_a_Storage_Domain.adoc[leveloffset=+3]
include::common/storage/proc-Removing_a_Storage_Domain.adoc[leveloffset=+3]

include::topics/Destroying_a_storage_domain.adoc[]

Expand Down
1 change: 1 addition & 0 deletions source/documentation/administration_guide/common
2 changes: 1 addition & 1 deletion source/documentation/administration_guide/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Administration Guide
include::../common/collateral_files/ovirt-attributes.adoc[]
include::common/collateral_files/ovirt-attributes.adoc[]

// Make sure Jekyll displays a guide title
[discrete]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[part-Administering_the_Environment]]
= Administering the Environment

include::../common/she/chap-Administering_the_Self-Hosted_Engine.adoc[leveloffset=+1]
include::common/she/chap-Administering_the_Self-Hosted_Engine.adoc[leveloffset=+1]

include::chap-Backups_and_Migration.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ There are two methods of adding labels to a host network interface:

You can automate the process of assigning labels to host network interfaces in the configured list of clusters with the LLDP Labeler service.

include::../../common/network/proc-Configuring_LLDP_Labeler.adoc[]
include::../common/network/proc-Configuring_LLDP_Labeler.adoc[]

You have added a network label to a host network interface. Newly created logical networks with the same label are automatically assigned to all host network interfaces with that label. Removing a label from a logical network automatically removes that logical network from all host network interfaces with that label.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Although network nodes and regular hosts can be used in the same cluster, virtua

. Use the Red Hat OpenStack Platform director to deploy the Networker role on the network node. See link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/advanced_overcloud_customization/index#sect-Creating_a_New_Role[Creating a New Role] and https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/advanced_overcloud_customization/index#Standalone-Networker[Networker] in the _Red Hat OpenStack Platform Advanced Overcloud Customization Guide_.
ifdef::rhv-doc[]
include::../../common/install/snip-RHEL_repo_steps.adoc[]
include::../common/install/snip-RHEL_repo_steps.adoc[]
endif::[]
. Install the Openstack Networking hook:
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can assign tags to and remove tags from hosts, virtual machines, and users.
*Adding and Removing Tags to and from Objects*

. Select the object(s) you want to tag or untag.
. Click *More Actions* (image:../common/images/moreactions.png[]), then click *Assign Tags*.
. Click *More Actions* (image:common/images/moreactions.png[]), then click *Assign Tags*.
. Select the check box to assign a tag to the object, or clear the check box to detach the tag from the object.
. Click btn:[OK].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Memory page sharing allows virtual machines to use up to 200% of their allocated memory by utilizing unused memory in other virtual machines. This process is based on the assumption that the virtual machines in your {virt-product-fullname} environment will not all be running at full capacity at the same time, allowing unused memory to be temporarily allocated to a particular virtual machine.

:context: cluster_opt_settings
include::../../common/admin/snip-CPU-Considerations.adoc[]
include::../common/admin/snip-CPU-Considerations.adoc[]

The table below describes the settings for the *Optimization* tab in the *New Cluster* and *Edit Cluster* windows.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ For details, see link:https://access.redhat.com/solutions/634853[].
. Click the *Fencing policy* tab to enable or disable fencing in the cluster, and select fencing options.
. Click the *MAC Address Pool* tab to specify a MAC address pool other than the default pool for the cluster. For more options on creating, editing, or removing MAC address pools, see xref:sect-MAC_Address_Pools[].
. Click btn:[OK] to create the cluster and open the *Cluster - Guide Me* window.
. The *Guide Me* window lists the entities that need to be configured for the cluster. Configure these entities or postpone configuration by clicking the *Configure Later* button. Configuration can be resumed by selecting the cluster and clicking *More Actions* (image:../common/images/moreactions.png[]), then clicking *Guide Me*.
. The *Guide Me* window lists the entities that need to be configured for the cluster. Configure these entities or postpone configuration by clicking the *Configure Later* button. Configuration can be resumed by selecting the cluster and clicking *More Actions* (image:common/images/moreactions.png[]), then clicking *Guide Me*.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can specify a MAC pool range for a cluster. Setting a MAC pool range is no l
. Enter the *Name* and *Description* of the data center.
. Select the *Storage Type*, *Compatibility Version*, and *Quota Mode* of the data center from the drop-down menus.
. Click btn:[OK] to create the data center and open the *Data Center - Guide Me* window.
. The *Guide Me* window lists the entities that need to be configured for the data center. Configure these entities or postpone configuration by clicking the *Configure Later* button. Configuration can be resumed by selecting the data center and clicking *More Actions* (image:../common/images/moreactions.png[]), then clicking *Guide Me*.
. The *Guide Me* window lists the entities that need to be configured for the data center. Configure these entities or postpone configuration by clicking the *Configure Later* button. Configuration can be resumed by selecting the data center and clicking *More Actions* (image:common/images/moreactions.png[]), then clicking *Guide Me*.


The new data center will remain *Uninitialized* until a cluster, host, and storage domain are configured for it; use *Guide Me* to configure these entities.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The LLDP Labeler service enables you to create a bond device automatically with

NICs with xref:Bond_logical_networks_compatibility[incompatible logical networks] cannot be bonded.

include::../../common/network/proc-Configuring_LLDP_Labeler.adoc[]
include::../common/network/proc-Configuring_LLDP_Labeler.adoc[]

. Attach a logical network to the new bond and configure it. See xref:Editing_host_network_interfaces[] for instructions.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can use tags to store information about your hosts. You can then search for
*Customizing hosts with tags*

. Click menu:Compute[Hosts] and select a host.
. Click *More Actions* (image:../common/images/moreactions.png[]), then click *Assign Tags*.
. Click *More Actions* (image:common/images/moreactions.png[]), then click *Assign Tags*.
. Select the check boxes of applicable tags.
. Click btn:[OK].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ A storage domain encountering errors may not be able to be removed through the n
*Destroying a Storage Domain*

. Click menu:Storage[Domains].
. Select the storage domain and click *More Actions* (image:../common/images/moreactions.png[]), then click *Destroy*.
. Select the storage domain and click *More Actions* (image:common/images/moreactions.png[]), then click *Destroy*.
. Select the *Approve operation* check box.
. Click btn:[OK].
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[Editing_VFs_on_NIC]]
==== Configuring virtual functions on a NIC

include::../../common/sriov/conc-Set_Up_and_Configure_SR-IOV.adoc[]
include::../common/sriov/conc-Set_Up_and_Configure_SR-IOV.adoc[]

Single Root I/O Virtualization (SR-IOV) enables you to use each PCIe endpoint as multiple separate devices by using physical functions (PFs) and virtual functions (VFs). A PCIe card can have between one and eight PFs. Each PF can have many VFs. The number of VFs it can have depends on the specific type of PCIe device.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[Enabling_Passthrough_on_a_vNIC_Profile]]
==== Enabling Passthrough on a vNIC Profile

include::../../common/sriov/conc-Set_Up_and_Configure_SR-IOV.adoc[]
include::../common/sriov/conc-Set_Up_and_Configure_SR-IOV.adoc[]

The passthrough property of a vNIC profile enables a vNIC to be directly connected to a virtual function (VF) of an SR-IOV-enabled NIC. The vNIC will then bypass the software network virtualization and connect directly to the VF for direct device assignment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Virtual disks can only be exported if they do not have multiple volumes, are not
====

. Click menu:Storage[Disks] and select the disks to export.
. Click *More Actions* (image:../common/images/moreactions.png[]), then click *Export*.
. Click *More Actions* (image:common/images/moreactions.png[]), then click *Export*.
. From the *Domain Name* drop-down list, select the OpenStack Image Service to which the disks will be exported.
. From the *Quota* drop-down list, select a quota for the disks if a quota is to be applied.
. Click btn:[OK].
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It may be necessary to *Destroy* a corrupted storage domain before you can *Forc
*Force Removing a Data Center*

. Click menu:Compute[Data Centers] and select the data center to remove.
. Click *More Actions* (image:../common/images/moreactions.png[]), then click *Force Remove*.
. Click *More Actions* (image:common/images/moreactions.png[]), then click *Force Remove*.
. Select the *Approve operation* check box.
. Click btn:[OK]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Only QEMU-compatible disks can be imported into the {engine-name}.

. Click menu:Storage[Domains].
. Click the storage domain's name. This opens the details view.
. Click *More Actions* (image:../common/images/moreactions.png[]), then click *Scan Disks* so that the {engine-name} can identify unregistered disks.
. Click *More Actions* (image:common/images/moreactions.png[]), then click *Scan Disks* so that the {engine-name} can identify unregistered disks.
. Click the *Disk Import* tab.
. Select one or more disk images and click *Import*.
. Select the appropriate *Disk Profile* for each disk.
Expand Down
Loading