Skip to content

Commit 68efa6b

Browse files
JoaoJandreJoão Jandre
andauthored
Update docs for 4.20 (#449)
* Update docs for 4.20 * fix typo * Address reviews * fix link * try to fix link again * fix the link this time for real * update to new system template naming scheme * address review * add more features * address review * fix changes --------- Co-authored-by: João Jandre <[email protected]>
1 parent 9032a43 commit 68efa6b

File tree

8 files changed

+2254
-3224
lines changed

8 files changed

+2254
-3224
lines changed

source/_global.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@
2525

2626
.. Latest version systemvm template name
2727
28-
.. |sysvm64-version| replace:: 4.19.1
29-
.. |sysvm64-name-xen| replace:: systemvm-xenserver-4.19.1
30-
.. |sysvm64-name-kvm| replace:: systemvm-kvm-4.19.1
31-
.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.19.1
32-
.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.19.1
33-
.. |sysvm64-name-ovm| replace:: systemvm-ovm-4.19.1
28+
.. |sysvm64-version| replace:: 4.20.0
29+
.. |sysvm64-name-xen| replace:: systemvm-xenserver-4.20.0-x86_64
30+
.. |sysvm64-name-kvm| replace:: systemvm-kvm-4.20.0-x86_64
31+
.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.20.0-x86_64
32+
.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.20.0-x86_64
33+
.. |sysvm64-name-ovm| replace:: systemvm-ovm-4.20.0-x86_64
3434

3535
.. Latest version systemvm template URL
36-
.. |sysvm64-url-xen| replace:: http://download.cloudstack.org/systemvm/4.19/systemvmtemplate-4.19.1-xen.vhd.bz2
37-
.. |sysvm64-url-kvm| replace:: http://download.cloudstack.org/systemvm/4.19/systemvmtemplate-4.19.1-kvm.qcow2.bz2
38-
.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.19/systemvmtemplate-4.19.1-vmware.ova
39-
.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.19/systemvmtemplate-4.19.1-hyperv.vhd.zip
40-
.. |sysvm64-url-ovm| replace:: http://download.cloudstack.org/systemvm/4.19/systemvmtemplate-4.19.1-ovm.raw.bz2
36+
.. |sysvm64-url-xen| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0.0-x86_64-xen.vhd.bz2
37+
.. |sysvm64-url-kvm| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0.0-x86_64-kvm.qcow2.bz2
38+
.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0.0-x86_64-vmware.ova
39+
.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0.0-x86_64-hyperv.vhd.zip
40+
.. |sysvm64-url-ovm| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0.0-x86_64-ovm.raw.bz2
4141

4242
.. Images
4343

source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
author = 'Apache CloudStack Project'
2525

2626
# The short X.Y version
27-
version = '4.19'
27+
version = '4.20'
2828
# The full version, including alpha/beta/rc tags
29-
release = '4.19.1.0'
29+
release = '4.20.0.0'
3030

3131
rst_epilog = """
3232
.. include:: /_global.rst

source/releasenotes/about.rst

Lines changed: 25 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -17,128 +17,37 @@
1717
What's New in |release|
1818
=======================
1919

20-
Apache CloudStack |release| is a 4.19 LTS minor release with over 300 fixes
21-
and improvements since the 4.19.0.0 release. Some of the highlights include:
22-
23-
• Improvements for VMware migration to KVM
24-
• Support to manage/unmanage DATA volume of a primary storage on KVM
25-
• Support for NFS mount options for a primary storage on KVM
26-
• Support to change storage pool scope from Cluster to Zone and vice versa
27-
• Support for RHEL/OL/Rocky/Alma Linux in the same cluster
28-
• Import from remote KVM enhancements
29-
• Storage plugins, PowerFlex, StorPool, Linstor related fixes and improvements
30-
• Some CKS, Veeam (B&R) related fixes and improvements
31-
• Several UI fixes and improvements
32-
33-
The full list of fixes and improvements can be found in the project release notes at
34-
https://docs.cloudstack.apache.org/en/4.19.1.0/releasenotes/changes.html
35-
36-
What's in since 4.19.0.0
37-
========================
38-
39-
Apache CloudStack 4.19.0.0 is the initial 4.19 LTS release with 300+ new
40-
features, improvements and bug fixes since 4.18, including 26 major
20+
Apache CloudStack 4.20.0.0 is the initial 4.20 LTS release with 190+ new
21+
features, improvements and bug fixes since 4.19, including 15 major
4122
new features. Some of the highlights include:
4223

43-
• CloudStack Object Storage Feature
44-
• VMware to KVM Migration
45-
• KVM Import
46-
• CloudStack DRS
47-
• OAuth2 Authentication
48-
• VNF Appliances Support
49-
• CloudStack DRS
50-
• CloudStack Snapshot Copy
51-
• Scheduled Instance Lifecycle Operations
52-
• Guest OS Management
53-
• Pure Flash Array and HPE-Primera Support
54-
• User-specified source NAT
55-
• Storage Browser
56-
• Safe CloudStack Shutdown
57-
• New CloudStack Dashboard
58-
• Domain migration
59-
• Flexible tags for hosts and storage pools
60-
• Support for Userdata in Autoscale Groups
61-
• KVM Host HA for StorPool storage
62-
• Dynamic secondary storage selection
63-
• Domain VPCs
64-
• Global ACL for VPCs
65-
66-
The full list of new features can be found in the project release notes at
67-
https://docs.cloudstack.apache.org/en/4.19.0.0/releasenotes/changes.html
68-
69-
.. _guestosids
70-
71-
Possible Issue with volume snapshot revert with KVM
72-
===================================================
73-
74-
Between versions 4.17.x, 4.18.0 and 4.18.1, KVM volume snapshot backups were
75-
not full snapshots and they rely on the primary storage as a backing store.
76-
To prevent any loss of data, care must be taken during revert operation and
77-
it must be ensured that the source primary storage snapshot file is present
78-
if the snapshot is created with any of these CloudStack versions.
79-
80-
Users will have a backing store in their volume snapshots in the following cases:
81-
82-
- the snapshots are from a ROOT volume created from template;
24+
• Webhooks
25+
• Dynamic and Static Routing
26+
• Ceph RGW Object Store Support
27+
• NSX integration
28+
• Shared Filesystems
29+
• Multi-arch Zones
30+
• Simple NAS backup plugin for KVM
31+
• Usage UI
32+
• API documentation in UI
8333

84-
Users will not have a backing store in their volume snapshots in the following cases:
8534

86-
- the snapshots are from ROOT volumes created with ISO;
87-
- the snapshots are from DATADISK volumes;
88-
89-
Following there are two queries to help users identify snapshots with a backing store:
90-
91-
Identify snapshots that were not removed yet and were created from a volume that was created from a template:
92-
93-
.. parsed-literal::
94-
SELECT s.uuid AS "Snapshot ID",
95-
s.name AS "Snapshot Name",
96-
s.created AS "Snapshot creation datetime",
97-
img_s.uuid AS "Sec Storage ID",
98-
img_s.name AS "Sec Storage Name",
99-
ssr.install_path AS "Snapshot path on Sec Storage",
100-
v.uuid AS "Volume ID",
101-
v.name AS "Volume Name"
102-
FROM cloud.snapshots s
103-
INNER JOIN cloud.volumes v ON (v.id = s.volume_id)
104-
INNER JOIN cloud.snapshot_store_ref ssr ON (ssr.snapshot_id = s.id
105-
AND ssr.store_role = 'Image')
106-
INNER JOIN cloud.image_store img_s ON (img_s.id = ssr.store_id)
107-
WHERE s.removed IS NULL
108-
AND v.template_id IS NOT NULL;
109-
110-
With that, one can use qemu-img info in the snapshot file to check if they have a backing store.
111-
112-
For those snapshots that have a backing store, one can use the following query to check which template is it and in which storage pool it is:
113-
114-
.. parsed-literal::
115-
SELECT vt.uuid AS "Template ID",
116-
vt.name AS "Template Name",
117-
tsr.install_path AS "Template file on Pri Storage",
118-
sp.uuid AS "Pri Storage ID",
119-
sp.name AS "Pri Storage Name",
120-
sp.`path` AS "Pri Storage Path",
121-
sp.pool_type as "Pri Storage type"
122-
FROM cloud.template_spool_ref tsr
123-
INNER JOIN cloud.storage_pool sp ON (sp.id = tsr.pool_id AND sp.removed IS NULL)
124-
INNER JOIN cloud.vm_template vt ON (vt.id = tsr.template_id)
125-
WHERE tsr.install_path = "<template file in the snapshot backing store>";
126-
127-
After identifying the snapshots with a backing store and the related templates, one can mount the secondary storage on a host that has access to the template and use qemu-img convert on the snapshot to consolidate it:
128-
129-
.. parsed-literal::
130-
qemu-img convert -O qcow2 -U --image-opts driver=qcow2,file.filename=<path to snapshot on secondary storage> <path to snapshot on secondary storage>-converted
131-
132-
Issue regarding LDAP authentication on version 4.19.0
133-
=====================================================
35+
The full list of new features can be found in the project release notes at
36+
https://docs.cloudstack.apache.org/en/4.20.0.0/releasenotes/changes.html
13437

135-
In version 4.19.0, the encryption of scoped configurations of Accounts and Domains was changed to only encrypt if there were sensitive data (e.g, they belonged to the Hidden or Secure category) as all configurations for Accounts and Domains were encrypted in previous versions. However, when using the encrypted values from these scopes, ACS did not correctly decrypt these values. For this reason, a simple solution was to update these configurations to their plain values with manual DB intervention, as reported in issue `#8637`.
38+
Log4j Upgrade
39+
=============
13640

137-
This issue has been fixed in Apache CloudStack 4.19.1.0. However, for users that manually set the configurations ``ldap.bind.password`` and ``ldap.truststore.password`` to a plain value in order to fix the faulty behaviour, it is required to store them encrypted after upgrading to version 4.19.1 and onwards. It will not be possible to update the configuration via UI, as an exception will be thrown when ACS tries to decrypt the plain value. To fix this, it is required to set the password again for ACS to encrypt it. There are two options:
41+
Up until 4.19.x.x, the logging library used for the project was Log4j 1.29.
42+
The 4.20.0.0 version has updated the library to Log4j2. The new Log4j2 configuration file format is not backwards
43+
compatible with the old one. The 4.20.0.0 packages will come with the default configuration files updated.
44+
Users that have made customizations to their files must update their configuration files to match with the new format,
45+
the `official Log4j documentation`_ might help you migrate your custom configurations.
13846

139-
#. Manually set the configuration via CloudMonkey, for example ``update configuration domainid=<domain-uuid> name="ldap.bind.password" value="password"``;
140-
#. Or, removing the defined configuration through the database via the query ``DELETE from cloud.domain_details WHERE name like "%ldap%password%"``, and setting the configuration via UI for the affected domains.
47+
JRE Upgrade
48+
============
14149

142-
After updating these configurations, LDAP authentication should be working as expected.
50+
Up until 4.19.x.x, the JRE used for ACS was JRE 11. In 4.20.0.0, JRE has been upgraded to JRE 17 as JRE 11 has reached EOL.
51+
This means that Centos7 (EL7) is no longer supported.
14352

144-
.. _`#8637`: https://github.com/apache/cloudstack/pull/8637
53+
.. _official Log4j documentation: https://logging.apache.org/log4j/2.x/migrate-from-log4j1.html

0 commit comments

Comments
 (0)